Endpoints
Custom fields
Contact properties you define, used in custom_fields on contacts.
Os caminhos são relativos à URL base. Cada card lista a permissão que a chamada exige e todos os parâmetros, com tipo e limites.
GET
/custom-fieldsList contact custom fields, including their type and options.
Permissão: contacts
GET
/custom-fields/:idRetrieve a custom field.
Permissão: contacts
Parâmetros de caminho
- idobrigatóriointeger
Custom field ID.
POST
/custom-fieldsCreate a contact custom field.
Proprietário ou admin
Corpo JSON
- labelobrigatóriostring
1–200 characters.
- keyopcionalstring
lower_snake_case, starts with a letter, up to 64 characters. Derived from the label when omitted.
- typeopcionalenum
Default "text".
Valores permitidos:
texttextareanumberbooleandateselectmulti_selecturl - optionsopcionalarray of strings
Required for select and multi_select, not allowed otherwise. Up to 200 unique options.
- descriptionopcionalstring
Up to 500 characters.
- ai_enabledopcionalboolean
Let the AI read and fill this field. Default true.
- show_in_tableopcionalboolean
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.