Skip to main content
POST
Criar campo adicional

Autorizações

Authorization
string
header
obrigatório

Access token OAuth 2.1.

Corpo

application/json
label
string
obrigatório

Rótulo do campo.

Required string length: 1 - 40
Exemplo:

"CPF"

key
string
obrigatório

Chave única no workspace. Apenas letras minúsculas, dígitos e underscores entre palavras.

Required string length: 1 - 35
Pattern: ^[a-z0-9]+(_[a-z0-9]+)*$
Exemplo:

"cpf_cliente"

type
enum<string>
obrigatório

Tipo do campo.

Opções disponíveis:
text,
long_text,
select,
multi_select,
cpf,
cnpj,
date,
number,
link,
address
value
object

Opções para tipos select e multi_select. Obrigatório quando type for select ou multi_select. Deve ser omitido para todos os outros tipos de campo.

Exemplo:
required
boolean

Se o campo é obrigatório. Padrão: false.

Exemplo:

false

show_people
boolean

Exibir em pessoas. Padrão: true.

Exemplo:

true

show_companies
boolean

Exibir em empresas. Padrão: true.

Exemplo:

false

show_deals
boolean

Exibir em negócios. Padrão: false.

Exemplo:

false

Resposta

Campo criado com sucesso.

data
object