Pular para o conteúdo

PUT /v1/contacts/custom-fields/catalog/{key}

PUT
/v1/contacts/custom-fields/catalog/{key}
curl --request PUT \
--url https://seu-endereco-da-api/v1/contacts/custom-fields/catalog/example \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Gerenciar campos personalizados (contacts:fields).

key
required
string
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

Example

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

Unknown platform field

The account already has its own field with that key