Errors

Every error is a JSON object with a single error string, written to be shown to a person.

Status	Meaning
`200`	Success
`201 Created`	The definition was created
`400 Bad Request`	A missing or invalid field, options on a non-choice type, or an attempt to change `type`, `key` or `entity`
`401 Unauthorized`	Missing, malformed, expired, or revoked API key
`403 Forbidden`	The key lacks `read:custom-fields` (for `GET`) or `write:custom-fields` (everything else)
`404 Not Found`	No definition with that ID in this workspace
`429 Too Many Requests`	Rate limit exceeded. See the `Retry-After` header

Examples

{ "error": "entity must be one of: CONTACT, LEAD, DEAL, COMPANY." }

{ "error": "type must be one of: TEXT, TEXTAREA, NUMBER, DATE, CHECKBOX, SELECT, MULTISELECT, URL, EMAIL, PHONE." }

{ "error": "options only apply to SELECT and MULTISELECT fields." }

{ "error": "A field's type, key and entity can't be changed. Delete it and create a new one instead." }

{ "error": "Custom field not found." }