Phones
Phones Documentation
Phone [LIST]
Phone [LIST]
Request
Endpoint
GET /api/v2/contacts/fabc6837-2c29-4a16-ac4f-dd3f8b0e5daa/people/a12d7421-770a-4aeb-a245-6d8794ceba67/phones
Content-Type: application/vnd.api+jsonBody
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": [
{
"id": "53021169-6d36-43a4-80d5-506c3c2eefae",
"type": "phone_numbers",
"attributes": {
"country_code": "1",
"created_at": "2022-01-12T17:18:18Z",
"historic": false,
"location": "mobile",
"number": "(213) 456-7890",
"primary": true,
"source": "MPDX",
"updated_at": "2022-01-12T17:18:18Z",
"updated_in_db_at": "2022-01-12T17:18:18Z",
"valid_values": true
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}Fields
data
Type
[Phone Number]
Description An array of Phone Numbers
Phone [POST]
Phone [POST]
Request
Endpoint
POST /api/v2/contacts/5358f572-82d6-4880-845a-53a78f6f2199/people/245887a5-a280-4e01-951b-7703e5cdf81b/phones
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "phone_numbers",
"attributes": {
"country_code": "MyString",
"location": "mobile",
"number": "3561987123",
"primary": false,
"updated_in_db_at": "2022-01-12 17:18:17 UTC",
"valid_values": true
}
}
}Parameters
Attributes
country_code
Type
number
Description The country code of the phone number
Required No
created_at
Type
date
Description The timestamp of when this resource was created
Required No
historic
Type
boolean
Description
This should be true when an phone number should no longer be used
Required No
location
Type
string
Description Essentially a label for the phone number, such as 'home', 'mobile', 'office'
Required No
number
Type
number
Description The number of the phone number resource
Required No
primary
Type
boolean
Description
Whether or not the number is the owner's primary phone number. Ultimately there should only be one of these.
Required No
source
Type
string
Description The source of the phone number
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
valid_values
Type
boolean
Description This boolean indicates whether the phone number is accurate or not
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
201 CreatedBody
{
"data": {
"id": "9bcf6424-ef75-409d-8731-8809d2b0301e",
"type": "phone_numbers",
"attributes": {
"country_code": "1",
"created_at": "2022-01-12T17:18:17Z",
"historic": false,
"location": "mobile",
"number": "3561987123",
"primary": false,
"source": "MPDX",
"updated_at": "2022-01-12T17:18:17Z",
"updated_in_db_at": "2022-01-12T17:18:17Z",
"valid_values": true
}
}
}Fields
Attributes
country_code
Type
number
Description The country code of the phone number
created_at
Type
date
Description The timestamp of when this resource was created
historic
Type
boolean
Description
This should be true when an phone number should no longer be used
location
Type
string
Description Essentially a label for the phone number, such as 'home', 'mobile', 'office'
number
Type
number
Description The number of the phone number resource
primary
Type
boolean
Description
Whether or not the number is the owner's primary phone number. Ultimately there should only be one of these.
source
Type
string
Description The source of the phone number
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
valid_values
Type
boolean
Description This boolean indicates whether the phone number is accurate or not
Phone [GET]
Phone [GET]
Request
Endpoint
GET /api/v2/contacts/eefc03da-13c3-49fa-acf0-d755517a2cef/people/1270222b-4638-4df4-9e1e-f048ba738d79/phones/87a37e5f-bf81-4b91-8392-593866b3baf1
Content-Type: application/vnd.api+jsonBody
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": {
"id": "87a37e5f-bf81-4b91-8392-593866b3baf1",
"type": "phone_numbers",
"attributes": {
"country_code": "1",
"created_at": "2022-01-12T17:18:18Z",
"historic": false,
"location": "mobile",
"number": "(213) 456-7890",
"primary": true,
"source": "MPDX",
"updated_at": "2022-01-12T17:18:18Z",
"updated_in_db_at": "2022-01-12T17:18:18Z",
"valid_values": true
}
}
}Fields
Attributes
country_code
Type
number
Description The country code of the phone number
created_at
Type
date
Description The timestamp of when this resource was created
historic
Type
boolean
Description
This should be true when an phone number should no longer be used
location
Type
string
Description Essentially a label for the phone number, such as 'home', 'mobile', 'office'
number
Type
number
Description The number of the phone number resource
primary
Type
boolean
Description
Whether or not the number is the owner's primary phone number. Ultimately there should only be one of these.
source
Type
string
Description The source of the phone number
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
valid_values
Type
boolean
Description This boolean indicates whether the phone number is accurate or not
Phone [PUT]
Phone [PUT]
Request
Endpoint
PUT /api/v2/contacts/a0fc7073-1d78-4f3d-b3cd-8e10df8cdbd4/people/19583994-f1b7-43aa-8f24-eaf0b2b4e8bf/phones/c4eca372-461d-4890-b5fe-8334772d5106
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "phone_numbers",
"attributes": {
"country_code": "MyString",
"location": "mobile",
"number": "3561987123",
"primary": false,
"updated_in_db_at": "2022-01-12 17:18:18 UTC",
"valid_values": true
}
}
}Parameters
Attributes
country_code
Type
number
Description The country code of the phone number
Required No
created_at
Type
date
Description The timestamp of when this resource was created
Required No
historic
Type
boolean
Description
This should be true when an phone number should no longer be used
Required No
location
Type
string
Description Essentially a label for the phone number, such as 'home', 'mobile', 'office'
Required No
number
Type
number
Description The number of the phone number resource
Required No
overwrite
Type
boolean
Description
Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.
Required No
primary
Type
boolean
Description
Whether or not the number is the owner's primary phone number. Ultimately there should only be one of these.
Required No
source
Type
string
Description The source of the phone number
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
valid_values
Type
boolean
Description This boolean indicates whether the phone number is accurate or not
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": {
"id": "c4eca372-461d-4890-b5fe-8334772d5106",
"type": "phone_numbers",
"attributes": {
"country_code": "1",
"created_at": "2022-01-12T17:18:18Z",
"historic": false,
"location": "mobile",
"number": "3561987123",
"primary": false,
"source": "MPDX",
"updated_at": "2022-01-12T17:18:18Z",
"updated_in_db_at": "2022-01-12T17:18:18Z",
"valid_values": true
}
}
}Fields
Attributes
country_code
Type
number
Description The country code of the phone number
created_at
Type
date
Description The timestamp of when this resource was created
historic
Type
boolean
Description
This should be true when an phone number should no longer be used
location
Type
string
Description Essentially a label for the phone number, such as 'home', 'mobile', 'office'
number
Type
number
Description The number of the phone number resource
primary
Type
boolean
Description
Whether or not the number is the owner's primary phone number. Ultimately there should only be one of these.
source
Type
string
Description The source of the phone number
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
valid_values
Type
boolean
Description This boolean indicates whether the phone number is accurate or not
Phone [DELETE]
Phone [DELETE]
Request
Endpoint
DELETE /api/v2/contacts/32ba2b1f-32ce-4061-9c5e-f1a6bed89e4d/people/1619c5c5-f852-4501-a39c-d835a2d4e746/phones/82881392-5c54-46a6-9c8b-8c5948373444
Content-Type: application/vnd.api+jsonBody
Response
Headers
204 No ContentBody
Last updated