POST /v1/contacts/custom-fields
const url = 'https://seu-endereco-da-api/v1/contacts/custom-fields';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"key":"example","label":"example","type":"example","options":["example"],"requiredStageIds":["example"],"sensitive":true,"position":1,"entity":"contact","description":"example","groupId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","viewRoleIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"viewDepartmentIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"editRoleIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"editDepartmentIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"validityDays":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://seu-endereco-da-api/v1/contacts/custom-fields \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "key": "example", "label": "example", "type": "example", "options": [ "example" ], "requiredStageIds": [ "example" ], "sensitive": true, "position": 1, "entity": "contact", "description": "example", "groupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "viewRoleIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "viewDepartmentIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "editRoleIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "editDepartmentIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "validityDays": 1 }'Permissão que a Chave de acesso precisa: Gerenciar campos personalizados (contacts:fields).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”object
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
True quando a chave era de um campo arquivado, que voltou com o tipo, as opcoes e os valores de antes
Example
{ "aiFillMode": "overwrite", "entity": "contact"}Key of an active field, of a platform field, or of an archived field of another entity