Delete Custom Field By Id

DELETE 
/custom-fields/:id

Delete Custom Field By Id.

info

Supports Custom Objects, Company (Business), and Project Management tasks (objectKey: "task", optional scopes). Contact and Opportunity fields continue to use the Locations custom-fields endpoints.

Request

Version stringrequired

API Version

Available optionsv3

id stringrequired

Unique identifier of the custom field or folder

application/json

Successful response

application/json

Schema

Schema

succededbooleanrequireddeprecated

Indicates whether the custom field or folder was successfully deleted (legacy field, misspelled).

idstringrequired

Unique identifier of the deleted custom field or folder

keystringrequired

Field key of the deleted custom field

Example (auto)

{
  "id": "661c06b4ffde146bdb469442",
  "key": "custom_object.pet.name"
}