custom-fields

Delete a custom field (v2)

Changed on

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 404 (v1 silently answered 200). In a workspace, an API key is refused with 403 forbidden: delete workspace fields in the Dex app.

delete/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
Example:01HV8N6X7K3P9Q5R2T4Y6W8Z0A

Optional. Accepted to dedupe retries on this endpoint. See apps/rest-api/src/shared/idempotency.ts.

Response

Successful response

Changes