Custom Fields

Set custom-field values on contacts

Batch-set per-contact custom-field VALUES (the `contacts_custom_fields` rows, not the field definitions). Body: `{ custom_fields: [{ contact_id, custom_field_id, text_value?, array_value?, date_value?

POST /v2/custom-fields/contacts/values

Parameters

Header parameters

Idempotency-Key

string required

Required. UUID per logical operation, reused on every retry. See apps/rest-api/src/shared/idempotency.ts for the full contract. Missing → 400 BadRequest; same key + different body → 409 Conflict.

Request body

Content-Type: application/json

custom_fields

array<object> required

custom_fields[].contact_id

string (uuid) required

custom_fields[].custom_field_id

string (uuid) required

custom_fields[].text_value

string

custom_fields[].date_value

string

custom_fields[].array_value

array<string>

custom_fields[].member_user_id

string

custom_fields[].number_value

number | null

custom_fields[].boolean_value

boolean | null

custom_fields[].linked_contact_ids

array<string (uuid)>

custom_fields[].linked_company_ids

array<string (uuid)>

custom_fields[].mode

string enum

Possible values: "replace", "prepend", "append"

custom_fields[].separator

string

Example

{
  "custom_fields": [
    {
      "contact_id": "00000000-0000-0000-0000-000000000000",
      "custom_field_id": "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 — 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/custom-fields/contacts/values \
  --request POST \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "custom_fields": [
    {
      "contact_id": "00000000-0000-0000-0000-000000000000",
      "custom_field_id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}'

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

requests.post(
    "https://api.prod.getdex.com/v2/custom-fields/contacts/values",
    headers={
      "Authorization": "Bearer YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    json={
      "custom_fields": [
        {
          "contact_id": "00000000-0000-0000-0000-000000000000",
          "custom_field_id": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
)

Reorder custom fields

Batch ranking update (`{ updates: [{ customFieldId, ranking }], entity_type? }`, max 100). `entity_type` (default `contact`) names whose fields are re-ranked; stale IDs and IDs of the other entity typ

Set custom-field values on companies

Batch-set custom-field VALUES on workspace companies (the `companies_custom_fields` rows and company links), 1 to 500 rows. Workspace only (`X-Dex-Workspace`); a Personal request is 404. Body: `{ cust