Custom Fields

Delete a custom field

Permanently delete a custom field definition and remove its values from all contacts.

DELETE /v1/custom-fields/{customFieldId}

Parameters

Path parameters

customFieldId

string (uuid) required

Responses

200 — Successful response

Content-Type: application/json

error

boolean required

message

string required

Example

{
  "error": false,
  "message": "string"
}

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/custom-fields/00000000-0000-0000-0000-000000000000 \
  --request DELETE \
  --header 'Authorization: Bearer YOUR_API_KEY'

fetch('https://api.prod.getdex.com/v1/custom-fields/00000000-0000-0000-0000-000000000000', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
})

requests.delete(
    "https://api.prod.getdex.com/v1/custom-fields/00000000-0000-0000-0000-000000000000",
    headers={
      "Authorization": "Bearer YOUR_API_KEY"
    }
)

Update a custom field

Update a custom field definition by its ID. You can modify the field name or other properties.

Batch update custom field values

Set or update custom field values for multiple contacts in a single request. Useful for bulk-populating custom fields across your contact database.