Skip to main content
PATCH
Alterar um campo personalizado
Envie só o que muda. options só vale em coluna do tipo select. A chave, o tipo e a entidade não mudam.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

ID do campo (UUID)

Body

application/json
label
string

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

Required string length: 1 - 60
Example:

"Convênio"

options
string[]

Só no campo de seleção (nos outros, 400)

Required array length: 1 - 50 elements
Required string length: 1 - 60
Example:
position
integer
Required range: 0 <= x <= 1000
agent_writable
boolean

Response

O campo alterado

id
string
required
entity
enum<string>
required

contact, company ou deal

Available options:
contact,
company,
deal
key
string
required

A chave que vai em custom_fields do contato e do negócio

label
string
required
type
enum<string>
required

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

Available options:
text,
number,
date,
select,
boolean
options
string[] | null
required

As opções, só em type select; null nos outros

position
number
required

A ordem na lista (menor primeiro)

agent_writable
boolean
required

O agente pode preencher o campo

created_at
string
required

Criação (UTC)

Example:

"2026-11-02T14:00:00.000Z"

updated_at
string
required

Última mudança (UTC)

Example:

"2026-11-02T14:00:00.000Z"