Skip to main content

Create a custom field

POST 
/custom-fields

Define a new custom field on a model (contact, company, deal, product, or task). Write access requires any contact, company, or deal write scope (or their .all variants) — no dedicated custom-field scope exists, and the same scopes cover every model above (task fields included). Choice types require options; File Upload uses options for its accepted formats. Place the field in a group with group_id (see GET /custom-field-groups); for product a group is optional and for task there are no groups at all, so group_id is rejected.

Request​

Responses​

The created custom field