Contacts

Bulk-delete contacts

Permanently delete multiple contacts in a single request. Returns `{ data: { affected, ids } }` where `ids` is the array of deleted contact IDs (echoed from the request body). `Idempotency-Key` is opt

POST /v2/contacts/batch-delete

Parameters

Header parameters

Idempotency-Key

string

Optional. Accepted to dedupe retries on this endpoint. See apps/rest-api/src/shared/idempotency.ts.

Request body

Content-Type: application/json

contactIds

array<string (uuid)> required

Example

{
  "contactIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

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

No response body.

401

No response body.

403

No response body.

404

No response body.

409

No response body.

429

No response body.

500

No response body.

Code samples

curl https://api.prod.getdex.com/v2/contacts/batch-delete \
  --request POST \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "contactIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

fetch('https://api.prod.getdex.com/v2/contacts/batch-delete', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    contactIds: ['00000000-0000-0000-0000-000000000000']
  })
})

requests.post(
    "https://api.prod.getdex.com/v2/contacts/batch-delete",
    headers={
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    json={
      "contactIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
)

Bulk-update contacts

Update multiple contacts in a single request. Per-row results are settled (some can succeed, others fail). **Requires `Idempotency-Key`.** Returns `{ data: { affected, ids } }` where `ids` lists the c

Merge duplicate contacts

Merge one or more groups of duplicate contacts. The request body is `{ contactIds: string[][] }` — each inner array is a group of ≥2 contact IDs to merge into a single surviving contact. Returns `{ da