create_custom_field
Add a custom field to Kommo CRM leads, contacts, or companies by specifying entity type, field type, and name. For select fields, provide enum_values; check existing fields first to avoid duplicates.
Instructions
Create a custom field on leads, contacts, or companies. Not idempotent: each call creates another field, so check list_custom_fields first. Returns the created field. Clears the custom-field cache for that entity. Provide enum_values for select-type fields.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Field display name. | |
| field_type | Yes | Kommo field type sent as-is, e.g. text, numeric, select, multiselect, date, url, checkbox. | |
| entity_type | Yes | Entity to add the field to: leads, contacts, or companies. | |
| enum_values | No | Option labels for select or multiselect fields, in display order, e.g. ["Low", "High"]. Ignored by other types. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Field ID. | |
| code | No | System field code, or null. | |
| name | No | Field name. | |
| sort | No | Sort order. | |
| type | No | Field type, e.g. text, select. | |
| enums | No | Options for select-like fields. | |
| _links | No | HAL links as returned by Kommo (self, next, ...). | |
| account_id | No | Kommo account ID. | |
| entity_type | No | Entity the field belongs to. | |
| is_api_only | No | Whether the field is API only. |