Skip to main content
PUT
Atualizar campo personalizado

Autorizações

Authorization
string
header
obrigatório

Token da API no formato sk_live_….

Parâmetros de caminho

id
integer
obrigatório

Corpo

application/json
name
string
obrigatório

Nome exibido.

Maximum string length: 60
Exemplo:

"Plano"

application
enum<string>
obrigatório

Onde o campo se aplica: contact em contatos, card em cards do CRM.

Opções disponíveis:
contact,
card
type
enum<string>
obrigatório

Tipo de valor aceito. Ele define a validação feita a cada gravação:

Opções disponíveis:
text,
number,
currency,
date,
select,
boolean,
email,
phone,
link,
textarea
key
string

Se você não informar, a chave é gerada a partir do nome, em minusculas_com_underline.

Maximum string length: 40
Exemplo:

"plano"

description
string | null

Descrição do campo personalizado.

Maximum string length: 120
groupName
string | null

Grupo do campo no formulário. Campos do mesmo grupo aparecem juntos.

Exemplo:

"Comercial"

isPublic
boolean
padrão:true

Deixa o campo visível para todos os atendentes. Quando falso, só quem tem permissão vê o campo.

alwaysVisible
boolean
padrão:false

Mostra o campo na ficha mesmo sem valor preenchido.

options
object[]

Lista de opções. Obrigatória quando type é select.

Resposta

OK

data
object
Exemplo: