34b7cf5b4b6c

latestOpenAPI 3.1.02026-08-122324681.8 MB
Custom Fields

Delete custom field

Delete a custom field definition. Fails with 422 if any record already has a value stored against this field — clear those values first, or archive the field via is_active=false instead.

delete/public/v2/custom-fields/{custom_field_id}/

Path parameters

custom_field_idinteger required

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Response

OK

successtrue
errorsobject