Use this endpoint to permanently delete a custom field from your account.
Endpoint
DELETE https://e1.envoke.com/v2/customfields/{ID}Replace {ID} with the Envoke custom field ID you want to delete. Authentication is via HTTP Basic Auth using your API ID and API Key.
Important
Deleting a custom field is permanent and cannot be undone.
When a custom field is deleted, all stored values for that field are also deleted across every contact in your account. If you have contacts with values stored in this field, those values will be permanently lost.
If you only want to stop using a custom field, consider updating its description to mark it as deprecated rather than deleting it.
Response
On success:
{ "success": true, "result_text": "Deleted", "result_data": [] }If the custom field ID is not found:
{ "success": false, "result_text": "Validation failed, see 'result_data' -> 'errors'", "result_data": { "errors": ["Item with id '42' not found"] } }Example
curl -X DELETE -gs \ -u "$API_ID:$API_KEY" \ "https://e1.envoke.com/v2/customfields/42"
Replace 42 with the ID of the custom field you want to delete, and substitute your actual API ID and API Key.
Note: The curl examples above are formatted for readability. All requests must use properly encoded URLs.
For code examples and interactive testing, visit api.envoke.com.