Contact Phone Numbers

Update a contact phone number

Partially update one phone number on a contact (value and/or label). **Requires `Idempotency-Key`.** Returns `{ data: { affected } }`.

PATCH /v2/contact-phone-numbers/{contactId}/{phoneNumberId}

Parameters

Path parameters

contactId

string (uuid) required

phoneNumberId

string (uuid) required

Request body

Content-Type: application/json

phone_number

string

label

string

ranking

integer

country_code

string

phone_number_sanitized

string

Example

{
  "phone_number": "string",
  "label": "string"
}

Responses

200 — Successful response

Content-Type: application/json

data

object required

data.affected

integer required

data.ids

array<string>

data.failed

array<object>

data.failed[].id

string

data.failed[].error

object

data.failed[].error.code

string

data.failed[].error.message

string

Example

{
  "data": {
    "affected": 0
  }
}

400 — Request body failed validation.

Content-Type: application/json

(body)

any

401 — Missing or invalid API key.

Content-Type: application/json

(body)

any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)

any

404 — Resource does not exist.

Content-Type: application/json

(body)

any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)

any

429 — Rate limit exceeded.

Content-Type: application/json

(body)

any

500 — Unexpected server error.

Content-Type: application/json

(body)

any

Code samples

curl https://api.prod.getdex.com/v2/contact-phone-numbers/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000 \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone_number": "string",
  "label": "string"
}'

fetch('https://api.prod.getdex.com/v2/contact-phone-numbers/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    phone_number: 'string',
    label: 'string'
  })
})

requests.patch(
    "https://api.prod.getdex.com/v2/contact-phone-numbers/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000",
    headers={
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    json={
      "phone_number": "string",
      "label": "string"
    }
)

Reorder contact phone numbers

Set the display order of a contact's phone numbers. Body is id-based: `{ order: [{ id, ranking }] }`. **Requires `Idempotency-Key`.** Returns `{ data: { affected } }`.

Delete a contact phone number

Remove a phone number from a contact. Idempotency-Key is optional. Returns `{ data: { affected } }`.