Atualizando um único campo personalizado

Este método permite atualizar um único campo personalizado de uma entidade (leads/contatos/empresas).

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

O método retorna um objeto atualizado do campo.

ParâmetroTipo de dadoDescriçãoCampo obrigatórioTipos de campos suportados
idintID do campo❌Disponível para todos os tipos de campos.
namestringNome do campo❌Disponível para todos os tipos de campos.
codestringCó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.
sortintOrdenação do campo no grupo de campos❌Disponível para todos os tipos de campos.
group_idstringID do grupo de campos❌Available for all lead, contact, company fields
is_api_onlyboolDefine se o campo é editável apenas via API❌Disponível para todos os campos de Lead, Contato e Empresa.
required_statusesarray|nullArray 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]objectModelo de campo obrigatório.❌Disponível para todos os campos de Lead, Contato e Empresa.
required_statuses[0][status_id]intID 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]intID do pipeline que exige um valor no campo antes de mover o lead❌Disponível para todos os campos de Lead, Contato e Empresa.
remindstring|nullConfiguraçã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.
enumsarrayArray 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]objectModelo 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]stringValor✅ (apenas se atualizar o campos do tipo:
-multiselect
-radiobutton
-select)
Disponível para os seguintes tipos de campo:
-multiselect
-radiobutton
-select
enums[0][sort]stringOrdenaçã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
nestedarrayArray de valor aninhado❌Disponível para os seguintes tipos de campo:
-categoria
nested[0]objectModelo de valor aninhado❌Disponível para os seguintes tipos de campo:
-categoria
nested[0][id]intID 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]intID do pai do valor aninhado❌Disponível para os seguintes tipos de campo:
-categoria
nested[0][value]stringValor do valor aninhado❌Disponível para os seguintes tipos de campo:
-categoria
nested[0][sort]intOrdenação do valor aninhado❌Disponível para os seguintes tipos de campo:
-categoria
nested[0][request_id]stringIdentificador 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]stringIdentificador 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
Path Params
string
enum
required

Tipo de entidade

Allowed:
int32
required

ID do campo

Body Params
string

Nome do campo

string

Código do campo que pode ser usado para atualizar o valor do campo sem passar o ID do campo na solicitação

int32

Ordenação do campo no grupo de campos

int32

ID do grupo de campos

boolean

Define se o campo é editável apenas via API. Disponível para todos os campos de lead, contato e empresa.

required_statuses
array of objects

Array of the fields required to change a lead status

required_statuses
string

Disponível apenas para campos do tipo data de nascimento. Configuração de lembretes de aniversário (nunca, dia – um dia antes do evento, semana – uma semana antes do evento, mês – um mês antes do evento)

enums
array of objects

Disponível para os seguintes tipos de campo: multiselect, radiobutton e select

enums
nested
array of objects

Array de valores aninhados. Disponível para os seguintes tipos de campo: categoria

nested
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json