Allo

Delete custom field

Removes a custom field from the API: it disappears from the list, its values are no longer returned on people, and writing to it with custom attributes…

DELETE/v2/api/crm/attributes/{key}

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.

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

StatusCodeWhen
400ATTRIBUTE_BUILT_INThe key is a built-in field, not a custom field
403API_KEY_INSUFFICIENT_SCOPEThe key does not hold CRM_DELETE
404TEAM_NOT_FOUNDThe workspace is not on the new contact model
404ATTRIBUTE_NOT_FOUNDNo field with this key, or the field is already deleted
409ATTRIBUTE_MANAGED_BY_INTEGRATIONThe field is managed by a CRM integration

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

keystringrequired

Field key, as returned by the list endpoint

Responses

204Field deleted
400
401
403
404
409
429