Endpoints

Custom fields

Contact properties you define, used in custom_fields on contacts.

Пути указаны относительно базового URL. В каждой карточке указано, какое разрешение нужно для вызова, и перечислены все параметры с типами и ограничениями.

GET

/custom-fields

List contact custom fields, including their type and options.

Разрешение: contacts

GET

/custom-fields/:id

Retrieve a custom field.

Разрешение: contacts

Параметры пути

idобязательноinteger
Custom field ID.

POST

/custom-fields

Create a contact custom field.

Владелец или admin

Тело JSON

labelобязательноstring
1–200 characters.
keyнеобязательноstring
lower_snake_case, starts with a letter, up to 64 characters. Derived from the label when omitted.
typeнеобязательноenum
Default "text".
Допустимые значения:texttextareanumberbooleandateselectmulti_selecturl
optionsнеобязательноarray of strings
Required for select and multi_select, not allowed otherwise. Up to 200 unique options.
descriptionнеобязательноstring
Up to 500 characters.
ai_enabledнеобязательноboolean
Let the AI read and fill this field. Default true.
show_in_tableнеобязательноboolean
Show as a column in the contacts table. Default false.

Answers 201. 409 conflict when the key already exists; 422 when the key is a built-in contact field.