Skip to Content
SendlySendly
API ReferenceContacts

Remove a custom field and its values from every contact

DELETE
/api/contacts/fields/{field}

Remove a custom field and its values from every contact. Runs in the background.

Requires the contacts:write scope — Create, update, and delete your contacts.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

field*string

Response Body

Accepted

application/json
  1. response

The removal was accepted and runs as a background job.

success*true
Value intrue
data*
Example Request
curl -X DELETE 'https://api.sendly.now/api/contacts/fields/string'
Example Response
{  "success": true,  "data": {    "status": "queued"  }}