Delete Custom Field Definition

DELETE

/api/:account_id/custom-field-definitions/:external_id

Delete a custom field definition and all its values.

This permanently deletes the definition and all values associated with it across all entities. The confirm_field_key must match the definition’s field_key to prevent accidental deletion.

Returns the count of deleted values in the X-Deleted-Values-Count header.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

external_idstringRequired

The custom field definition ID (e.g., ‘cfd_dev_abc123’)

account_idstringRequired

Request

This endpoint expects an object.

confirm_field_keystringRequired

Must match the field_key of the definition to confirm deletion

Response

Successful Response

Errors

422

Unprocessable Entity Error

$	curl -X DELETE https://app.paymentkit.com/api/account_id/custom-field-definitions/external_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"confirm_field_key": "customer_loyalty_points"
>	}'