Delete a custom field

Deletes a field definition - only when nothing references it (usage_count must be 0, otherwise 409 custom_field_in_use; detach it from every card’s form_builder first). Scope: custom_fields:write.

What happens to data:

• Stored customer values under this key are PRESERVED on the customer records (history) but stop validating and stop rendering
• The key becomes available again; re-creating it with a DIFFERENT type is allowed - old stored values simply fail validation on their next write (no silent coercion)

DELETE /v1/custom_fields/{id}

Delete a custom field

cURL

curl --request DELETE \
  --url https://api.vexioncards.one/v1/custom_fields/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "cf_wrxiel4memql2norlmv6teauji",
  "object": "custom_field",
  "deleted": true
}

Authorizations

Authorization · string · header · required

Your secret API key as a Bearer token: Authorization: Bearer vxn_sk_.... Keys are created and scoped in the dashboard - see Authentication.

Headers

Idempotency-Key · string

Recommended on PATCH and DELETE for safe retries.

Path Parameters

id · string · required

Custom field identifier (cf_ prefix).

Pattern: ^cf_[A-Za-z0-9]+$

Response

200

application/json

Deletion confirmed. Stored customer values under this key are preserved (see the endpoint description).

id · string · required

The id of the deleted resource.

Example:

"cf_wrxiel4memql2norlmv6teauji"

object · string · required

Always "custom_field".

Allowed value: "custom_field"

deleted · boolean · required

Always true - the deletion confirmation marker.