Phones

Phones Documentation

Phone [LIST]

Phone [LIST]

Request

Endpoint

GET /api/v2/contacts/16a784ed-61af-4567-8719-5fdf052094d3/people/a8af80d7-6a9d-4476-8ca5-de873603b89a/phones
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": [
    {
      "id": "ea6b5113-a325-4999-bd06-4354f3ffa67b",
      "type": "phone_numbers",
      "attributes": {
        "country_code": "1",
        "created_at": "2021-11-23T14:37:33Z",
        "historic": false,
        "location": "mobile",
        "number": "[phone]",
        "primary": true,
        "source": "MPDX",
        "updated_at": "2021-11-23T14:37:33Z",
        "updated_in_db_at": "2021-11-23T14:37:33Z",
        "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/c794e384-531a-4104-abd3-384cb193b599/people/e7bb2201-90de-4e1c-85af-1e4f66229472/phones
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "phone_numbers",
    "attributes": {
      "country_code": "MyString",
      "location": "mobile",
      "number": "3561987123",
      "primary": false,
      "updated_in_db_at": "2021-11-23 14:37:33 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 Created

Body

{
  "data": {
    "id": "8e01b33a-7b90-4749-b9e3-4b0a007ca90c",
    "type": "phone_numbers",
    "attributes": {
      "country_code": "1",
      "created_at": "2021-11-23T14:37:33Z",
      "historic": false,
      "location": "mobile",
      "number": "3561987123",
      "primary": false,
      "source": "MPDX",
      "updated_at": "2021-11-23T14:37:33Z",
      "updated_in_db_at": "2021-11-23T14:37:33Z",
      "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/9724ba19-a2fb-440c-99c7-d81cd2e66060/people/7b7156db-0684-43c3-a94e-d8fcbb37c5e2/phones/2536773f-5818-4004-9f65-586bdcdc3d2b
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "2536773f-5818-4004-9f65-586bdcdc3d2b",
    "type": "phone_numbers",
    "attributes": {
      "country_code": "1",
      "created_at": "2021-11-23T14:37:32Z",
      "historic": false,
      "location": "mobile",
      "number": "[phone]",
      "primary": true,
      "source": "MPDX",
      "updated_at": "2021-11-23T14:37:32Z",
      "updated_in_db_at": "2021-11-23T14:37:32Z",
      "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/e537cab2-48db-4676-b359-90c8a0b9d65f/people/2aed265e-06a0-4286-85b4-7ce02afb4136/phones/e2847052-3873-48fc-bfc1-6a4c0cf53181
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "phone_numbers",
    "attributes": {
      "country_code": "MyString",
      "location": "mobile",
      "number": "3561987123",
      "primary": false,
      "updated_in_db_at": "2021-11-23 14:37:33 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 OK

Body

{
  "data": {
    "id": "e2847052-3873-48fc-bfc1-6a4c0cf53181",
    "type": "phone_numbers",
    "attributes": {
      "country_code": "1",
      "created_at": "2021-11-23T14:37:33Z",
      "historic": false,
      "location": "mobile",
      "number": "3561987123",
      "primary": false,
      "source": "MPDX",
      "updated_at": "2021-11-23T14:37:33Z",
      "updated_in_db_at": "2021-11-23T14:37:33Z",
      "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/eb9e0c3c-363b-4c0d-9ce1-1964fb7df904/people/6a937be4-b9d7-458f-9f3f-6cc5b56d2286/phones/5a80bc2f-e2d0-4b54-9ec9-3ba06e210adb
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body