Contacts

Delete multiple contacts

Delete multiple contacts in a single request by providing an array of contact IDs. This permanently removes the contacts and their associated data.

DELETE /v1/contacts/

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

error

boolean required

data

object required

data.count

integer required

data.contact_ids

array<string (uuid)> required

Example

{
  "error": false,
  "data": {
    "count": 0,
    "contact_ids": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
}

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/v1/contacts/ \
  --request DELETE \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "contactIds": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

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

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

Update multiple contacts

Update multiple contacts in a single request. Each contact in the request body must include its ID along with the fields to update.

Find contacts by email

Look up contacts by one or more email addresses. Returns matching contacts for each email provided, useful for resolving email addresses to contact records.