Phone Number

A prospect's phone number

countryCode
string <= 255 characters

The country code (e.g. US)

createdAt
string <date-time>

The date and time the phone number was created.

extension
string <= 255 characters

Phone number extension (e.g. 123)

number
string <= 255 characters

The phone number (e.g. +18889387356)

order
integer

Ordered position in list of numbers

phoneType
string <= 255 characters

Type of phone (mobile, work, home, voip, and other)

rawNumber
string <= 255 characters

Unformatted phone number

status
string <= 255 characters

The status of the number

statusChangedAt
string <date-time>

Time the status was updated

updatedAt
string <date-time>

The date and time the phone number was last updated.

{
}

Phone Number Relationships

data (object) or links (object) (prospect)

The owning prospect You can use only the attribute id to filter phoneNumbers by prospect (e.g. filter[prospect][id]=X).

{
}

Phone Number Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Phone Number Actions

Get a Collection of Phone Numbers

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/phoneNumbers
Request samples 
Response samples 
application/vnd.api+json
{
}
Create a New Phone Number
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/phoneNumbers
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}
Delete an Existing Phone Number by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/phoneNumbers/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Get a Phone Number by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/phoneNumbers/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Update a Phone Number
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/phoneNumbers/{id}
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}