Contact Phone Numbers

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

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

Parameters

Path parameters

contactId

string (uuid) required

Request body

Content-Type: application/json

order

array<object> required

order[].id

string (uuid) required

order[].ranking

integer required

Example

{
  "order": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "ranking": 0
    }
  ]
}

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/reorder \
  --request POST \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "order": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "ranking": 0
    }
  ]
}'

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

requests.post(
    "https://api.prod.getdex.com/v2/contact-phone-numbers/00000000-0000-0000-0000-000000000000/reorder",
    headers={
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    json={
      "order": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "ranking": 0
        }
      ]
    }
)

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.

Update a contact phone number

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