Pular para o conteúdo

POST /v1/contacts/custom-fields

POST
/v1/contacts/custom-fields
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).

Media typeapplication/json
object
key
required
string
>= 1 characters
label
required
string
>= 1 characters
type
required
string
options
Array<string>
requiredStageIds
Array<string>
sensitive
boolean
position
number
entity
string
Allowed values: contact company deal conversation ticket
description
string
nullable <= 500 characters
groupId
string format: uuid
nullable
viewRoleIds
Array<string>
viewDepartmentIds
Array<string>
editRoleIds
Array<string>
editDepartmentIds
Array<string>
validityDays
number
nullable >= 1 <= 3650
Media typeapplication/json
object
id
required
string
key
required
string
label
required
string
type
required
string
options
required
Array<object>
object
id
required
string
value
required
string
requiredStages
required
Array<object>
object
stageId
required
string
stageName
required
string
pipelineId
required
string
pipelineName
required
string
system
required
boolean
sensitive
required

True quando o valor fica escondido até alguém revelar e não sai na planilha

boolean
aiFillable
required

True quando o dono liberou a IA para preencher este campo; campo sensivel nunca e liberado

boolean
aiFillMode
required

Overwrite: a IA troca o valor que ja existe; empty_only: a IA so preenche o campo vazio de contato

string
Allowed values: overwrite empty_only
description
required

O que o campo guarda, mostrado como ajuda na ficha

string
nullable
groupId
required

Grupo em que o campo aparece; null quando fica solto

string
nullable
entity
required

A quem o campo pertence: contato, empresa ou negocio; campo de negocio nao pode ser sigiloso

string
Allowed values: contact company deal conversation ticket
position
required
number
fromNetwork
required

True quando o campo veio da rede; so o dono da rede renomeia ou remove

boolean
viewRoleIds
required

Papeis que veem o campo; vazio com viewDepartmentIds vazio e todos

Array<string>
viewDepartmentIds
required

Setores que veem o campo; vale quem esta em qualquer papel ou setor da lista

Array<string>
editRoleIds
required

Papeis que editam o campo, entre os que veem; vazio com editDepartmentIds vazio e todos que veem

Array<string>
editDepartmentIds
required

Setores que editam o campo, entre os que veem

Array<string>
computed
required

True quando o campo se calcula sozinho a partir das compras ou das conversas; ninguem digita o valor

boolean
canEdit
required

True quando quem pediu pode gravar o campo; quem gerencia os campos ve e edita todos; campo calculado e sempre false

boolean
validityDays
required

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

number
nullable
inboxBadge
required

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

boolean
reactivated
required

True quando a chave era de um campo arquivado, que voltou com o tipo, as opcoes e os valores de antes

boolean

Example

{
"aiFillMode": "overwrite",
"entity": "contact"
}

Key of an active field, of a platform field, or of an archived field of another entity