Contact fields

Delete a custom contact field

Permanently delete a custom field definition and strip its stored value from every contact. Any template variable that referenced it will resolve to empty. On more than 5,000 contacts the strip runs as a background job and the response is 202 with the job's progress instead of 204. This can't be undone — recreate the field with Create a custom contact field if you need it back. Requires the contacts:write capability.

delete/contact-fields/{id}

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/contact-fields/{id}
  • Auth: HTTP bearer

Response

Accepted: the field held a value on more than 5,000 contacts, so the strip runs as a background job. The field is already gone from lists; GET /contact-fields/{id} answers 404 once the job's final step removed it. The body is the job; follow it with GET /jobs/{id} until its status is COMPLETED (or FAILED).

object'job' required
idstring required
kindstring required
status'QUEUED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' required
totalinteger nullable required
processedinteger required
failedinteger required
errorstring nullable required
created_atstring required
completed_atstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.