Skip to main content
DELETE
Delete custom contact field
Required scope: CRM_DELETE
Removes the field from the API. It disappears from List custom fields, its values are no longer returned on people, and writing to it with custom_attributes returns CUSTOM_ATTRIBUTE_KEY_UNKNOWN. Returns 204 No Content.
The values stored on people are kept. Creating a field with the same label and type with Create custom field restores the field and its values. The field keeps its slot toward the limits until then. This differs from Delete company attribute, which clears the values.
Fields synced from a CRM integration cannot be deleted. Remove them in the connected CRM. Built-in fields such as name or company cannot be deleted either.

Errors

Authorizations

Authorization
string
header
required

Path Parameters

key
string
required

Field key, as returned by the list endpoint

Example:

"lead_status"

Response

Field deleted