Define a custom field
crm_define_fieldAdd a field of your own to contacts, companies or deals, such as a "plan" picked from a list or a "renewal_date", or change its label, description or options. From then on values sent in custom_fields are checked against its type (text, number, boolean, date as YYYY-MM-DD, select from options, url, email, phone), and you can filter and sort on it. A field that holds values keeps its type; delete it and define it again to change the type. Costs $0.001 per call; nothing if it fails.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | snake_case, e.g. "renewal_date" | |
| type | Yes | ||
| label | No | ||
| object | Yes | ||
| options | No | select only: the allowed values | |
| description | No | What the field means, for whoever reads it next. |