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

Parâmetro	Tipo de dado	Descrição	Campo obrigatório	Tipos de campos suportados
id	int	ID 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	❌	Available for all lead, contact, company fields
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.	✅ (apenas se atualizar o campos do tipo: -multiselect -radiobutton -select)	Disponível para os seguintes tipos de campo: -multiselect -radiobutton -select
enums[0]	object	Modelo de valor disponível.	✅ (apenas se atualizar o campos do tipo: -multiselect -radiobutton -select)	Disponível para os seguintes tipos de campo: -multiselect -radiobutton -select
enums[0][value]	string	Valor	✅ (apenas se atualizar o campos do tipo: -multiselect -radiobutton -select)	Disponível para os seguintes tipos de campo: -multiselect -radiobutton -select
enums[0][sort]	string	Ordenação de valores.	✅(only if you update a field of types: multiselect radiobutton select	Disponível para os seguintes tipos de campo: -multiselect -radiobutton -select
nested	array	Array de valor aninhado	❌	Disponível para os seguintes tipos de campo: -categoria
nested[0]	object	Modelo de valor aninhado	❌	Disponível para os seguintes tipos de campo: -categoria
nested[0][id]	int	ID do valor aninhado. Não deve ser passado ao criar um novo valor	❌	Disponível para os seguintes tipos de campo: -categoria
nested[0][parent_id]	int	ID do pai do valor aninhado	❌	Disponível para os seguintes tipos de campo: -categoria
nested[0][value]	string	Valor do valor aninhado	❌	Disponível para os seguintes tipos de campo: -categoria
nested[0][sort]	int	Ordenação do valor aninhado	❌	Disponível para os seguintes tipos de campo: -categoria
nested[0][request_id]	string	Identificador temporário de um valor aninhado. O identificador deve ser único para a solicitação, não é salvo em nenhum lugar e é usado para criar mais de um nível de aninhamento dentro de uma solicitação.	❌	Disponível para os seguintes tipos de campo: -categoria
nested[0][parent_request_id]	string	Identificador temporário do pai de um valor aninhado. O identificador é usado apenas no momento da solicitação, não é salvo em nenhum lugar e define o nível de aninhamento do elemento adicionado caso o elemento pai ainda não tenha sido criado.	❌	Disponível para os seguintes tipos de campo: -categoria