PATCH /v1/contacts/custom-fields/{id}
const url = 'https://seu-endereco-da-api/v1/contacts/custom-fields/example';const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://seu-endereco-da-api/v1/contacts/custom-fields/example \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Gerenciar campos personalizados (contacts:fields).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”Responses
Seção intitulada “Responses”object
object
object
True quando o valor fica escondido até alguém revelar e não sai na planilha
True quando o dono liberou a IA para preencher este campo; campo sensivel nunca e liberado
Overwrite: a IA troca o valor que ja existe; empty_only: a IA so preenche o campo vazio de contato
O que o campo guarda, mostrado como ajuda na ficha
Grupo em que o campo aparece; null quando fica solto
A quem o campo pertence: contato, empresa ou negocio; campo de negocio nao pode ser sigiloso
True quando o campo veio da rede; so o dono da rede renomeia ou remove
Papeis que veem o campo; vazio com viewDepartmentIds vazio e todos
Setores que veem o campo; vale quem esta em qualquer papel ou setor da lista
Papeis que editam o campo, entre os que veem; vazio com editDepartmentIds vazio e todos que veem
Setores que editam o campo, entre os que veem
True quando o campo se calcula sozinho a partir das compras ou das conversas; ninguem digita o valor
True quando quem pediu pode gravar o campo; quem gerencia os campos ve e edita todos; campo calculado e sempre false
Dias que o valor vale depois de gravado; vencido, a varredura do flow-engine publica o vencimento, que pode disparar fluxo; null vale para sempre; so campo de contato que nao e calculado
True quando o dono escolheu o campo como selo da caixa de entrada; ate 2 por conta, escolhidos em PUT /contacts/custom-fields/inbox-badges
Example
{ "aiFillMode": "overwrite", "entity": "contact"}