Contact Phone Numbers

Create a contact phone number

Add a phone number to a contact, optionally with a label. **Requires `Idempotency-Key`.** Returns the created row: `{ data: { contact_phone_number: {...} } }`, status 201.

POST /v2/contact-phone-numbers/{contactId}

Parameters

Path parameters

contactId

string (uuid) required

Request body

Content-Type: application/json

phone_number

string required

label

string

ranking

integer

country_code

string

phone_number_sanitized

string

Example

{
  "phone_number": "string"
}

Responses

201 — Created

Content-Type: application/json

data

object required

data.phoneNumber

object required

data.phoneNumber.id

string (uuid) required

data.phoneNumber.contact_id

string (uuid) required

data.phoneNumber.user_id

string

data.phoneNumber.phone_number

string required

data.phoneNumber.label

string | null

data.phoneNumber.ranking

integer required

data.phoneNumber.country_code

string | null

data.phoneNumber.phone_number_sanitized

string | null

data.phoneNumber.created_at

string (date-time) required

data.phoneNumber.updated_at

string (date-time) required

Example

{
  "data": {
    "phoneNumber": {
      "id": "00000000-0000-0000-0000-000000000000",
      "contact_id": "00000000-0000-0000-0000-000000000000",
      "phone_number": "string",
      "ranking": 0,
      "created_at": "2026-09-17T02:39:21.281Z",
      "updated_at": "2026-09-17T02:39:21.281Z"
    }
  }
}

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 \
  --request POST \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone_number": "string"
}'

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

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

Delete a contact email

Remove an email from a contact. Idempotency-Key is optional (delete is idempotent; a key replays the same `affected` on retry). Returns `{ data: { affected } }`.

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 } }`.