custom-fields

Update a custom field (v2)

Changed on

Partial update of a custom field definition (name, field_type, categories). In a workspace (X-Dex-Workspace), only owners and admins may edit one, with an API key too. Requires Idempotency-Key. Returns { data: { custom_field: {...} } }.

patch/v2/custom-fields/{customFieldId}

Request

  • Base URL: https://api.prod.getdex.com
  • URL: https://api.prod.getdex.com/v2/custom-fields/{customFieldId}
  • Auth: HTTP bearer

Path parameters

customFieldIdstring uuid required

Headers

Idempotency-Keystring required
Example:01HV8N6X7K3P9Q5R2T4Y6W8Z0A

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

Response

Successful response

Changes

  • 62f85fb89e0eRevision changes
    • info

      added the new boolean enum value to the request property /

    • info

      added the new contact enum value to the request property /

    • info

      added the new multiselect enum value to the request property /

    • info

      added the new number enum value to the request property /

  • 442b12828a68Revision changes
    • info

      added the new teammate enum value to the request property /

    • info

      added the optional property // to the response with the status