Dex Guide
Dex Dashboard
Custom Fields

Update a custom field

Partial update of a custom field definition (`name`, `field_type`, `categories`). **Requires `Idempotency-Key`.** Returns `{ data: { custom_field: {...} } }`.

PATCH /v2/custom-fields/{customFieldId}

Parameters

Path parameters

customFieldId
string (uuid) required

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_field
object required
custom_field.name
string
custom_field.field_type
string enum
Possible values: "input", "autocomplete", "datepicker"
custom_field.categories
array<object>
custom_field.categories[].category
string

Example

{
  "custom_field": {
    "name": "string",
    "field_type": "input"
  }
}

Responses

200 — Successful response

Content-Type: application/json

data
object required
data.custom_field
object required
data.custom_field.id
string (uuid) required
data.custom_field.user_id
string
data.custom_field.name
string
data.custom_field.field_type
string
data.custom_field.categories
array<string>
data.custom_field.ranking
integer | null

Example

{
  "data": {
    "custom_field": {
      "id": "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/v2/custom-fields/00000000-0000-0000-0000-000000000000 \
  --request PATCH \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "custom_field": {
    "name": "string",
    "field_type": "input"
  }
}'

Create a custom field

Create ONE custom field definition. Accepts `name`, `field_type` (`input` | `autocomplete` | `datepicker`), and `categories` (autocomplete only, as `[{ category }]`). Ranking is assigned automatically

Delete a custom field

Permanently delete a custom field definition (per-contact values cascade). Returns `{ data: { affected: 1, ids: [customFieldId] } }`. `Idempotency-Key` is optional. Deleting a missing field returns 40

Copyright © 2026