post
https://{subdomain}.kommo.com/api/v4//custom_fields
Este método permite adicionar um ou vários campos personalizados a uma entidade (leads, empresas, contatos).
Limitações
O método é disponível apenas para usuários administradores.
Cabeçalho de tipo de dado quando a solicitação é bem-sucedida
Content-Type: application/hal+json
Cabeçalho de tipo de dado em caso de erro
Content-Type: application/problem+json
Parâmetros de resposta
Para adicionar um campo personalizado, um objeto de campo deve ser passado.
| Parâmetro | Tipo de dado | Descrição | Campo obrigatório? | Tipos de campos suportados |
|---|---|---|---|---|
| type | string | Tipo do campo | ✅ | Disponível para todos os tipos de campos. |
| name | string | Nome do campo | ✅ | Disponível para todos os tipos de campos. |
| code | string | Código do campo que pode ser usado para atualizar o valor sem passar o ID do campo na solicitação. | ❌ | Disponível para todos os tipos de campos. |
| sort | int | Ordenação do campo no grupo de campos | ❌ | Disponível para todos os tipos de campos. |
| group_id | string | ID do grupo de campos | ❌ | Disponível para todos os campos de Lead, Contato e Empresa. |
| is_api_only | bool | Define se o campo é editável apenas via API | ❌ | Disponível para todos os campos de Lead, Contato e Empresa. |
| required_statuses | array|null | Array dos campos obrigatórios para alterar o status de um lead | ❌ | Disponível para todos os campos de Lead, Contato e Empresa. |
| required_statuses[0] | object | Modelo de campo obrigatório. | ❌ | Disponível para todos os campos de Lead, Contato e Empresa. |
| required_statuses[0][status_id] | int | ID do estágio que exige um valor no campo antes de mover o lead | ❌ | Disponível para todos os campos de Lead, Contato e Empresa. |
| required_statuses[0][pipeline_id] | int | ID do pipeline que exige um valor no campo antes de mover o lead | ❌ | Disponível para todos os campos de Lead, Contato e Empresa. |
| remind | string|null | Configuração de lembretes de aniversário (nunca, dia - dia antes do evento, semana - semana antes do evento, mês - mês antes do evento) | ❌ | Disponível apenas para campos de data de nascimento. |
| enums | array | Array de valores disponíveis para campos com valores enumerados. | ✅ | Disponível para os seguintes tipos de campo: -multiselect -radiobutton -select |
| enums[0] | object | Modelo de valor disponível. | ✅ | Disponível para os seguintes tipos de campo: -multiselect -radiobutton -select |
| enums[0][value] | string | Valor | ✅ | Disponível para os seguintes tipos de campo: -multiselect -radiobutton -select |
| enums[0][sort] | string | Ordenação de valores. | ✅ | Disponível para os seguintes tipos de campo: -multiselect -radiobutton -select |