Delete a custom field
Permanently delete a custom field definition. Values already stored on contacts are left in place, as in the app.
DELETE
https://api.centerfy.ai/webhooks/inbound/custom-fields/:id Headers
| Header | Required | Value | Description |
|---|---|---|---|
x-api-key | Yes | your sub-account API key (cfy_…) | Authenticates the request; or use Authorization: Bearer <key>. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | The custom field definition id. |
Example
curl -X DELETE "https://api.centerfy.ai/webhooks/inbound/custom-fields/{id}" \
-H "x-api-key: $CENTERFY_API_KEY" import { CenterfyClient } from "@centerfy/sdk";
const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });
const result = await centerfy.customFields.delete("<customFieldId>");
console.log(result); centerfy customFields delete <customFieldId> MCP tool: centerfy_custom_fields_delete (see MCP server)
Response
{
"status": "success",
"deleted": true,
"custom_field_id": "4b5c6d7e-8f90-4a1b-9c2d-3e4f5a6b7c8d"
}Errors
400— if the id is not a valid UUID; 404 if the field is not in this sub-account; 409 if the field is managed in GoHighLevel.