Skip to main content
POST
Criar ou atualizar um campo personalizado pela chave

Como funciona

A rota decide pela key dentro da entidade. Se não existe coluna ativa com essa chave, ela é criada e a resposta é 201 com created: true. Se já existe com o mesmo tipo, o rótulo e as opções são atualizados (e o agent_writable, quando você envia) e a resposta é 200 com created: false. Por isso você pode chamar a rota sempre que a sua integração sobe, sem conferir antes. Sem key, a chave sai do rótulo: “Convênio médico” vira convenio_medico. agent_writable diz se os agentes podem preencher a coluna durante a ligação ou a conversa. Vale true na criação quando você não envia.
A chave, o tipo e a entidade não mudam depois que a coluna existe. Enviar a mesma chave com outro tipo responde 409.

Exemplo

Limites

Erros

Authorizations

Authorization
string
header
required

API Key da organização (Authorization: Bearer ik_live_xxx)

Body

application/json
entity
enum<string>
required

contact, company ou deal

Available options:
contact,
company,
deal
label
string
required

O nome que o painel mostra (até 60 caracteres)

Required string length: 1 - 60
Example:

"Convênio"

type
enum<string>
required

text, number, date, select ou boolean. O tipo nunca muda depois de criado

Available options:
text,
number,
date,
select,
boolean
key
string

A chave do campo. Sem ela, sai do rótulo (sem acento, minúscula, só letras, números e _)

Pattern: ^[a-z][a-z0-9_]{0,39}$
Example:

"convenio"

options
string[]

As opções da seleção: de 1 a 50, cada uma com até 60 caracteres, sem repetir. Só em type select, e obrigatório nele

Required array length: 1 - 50 elements
Required string length: 1 - 60
Example:
agent_writable
boolean

O agente pode preencher. Default: true no campo novo; no que já existe, o valor atual fica

Response

Já existia com o mesmo tipo: atualizado (created: false)

created
boolean
required
field
object
required