Campos

Referência dos campos aceitos pelos formulários e pela API do CRM ao criar ou editar um contato, uma oportunidade ou um campo personalizado. Cada tabela lista o nome do campo, o tipo, a restrição e se é obrigatório.

Papel exigido: criar ou editar contatos e criar oportunidades exige o papel Proprietário, Administrador, Editor ou Atendente no workspace — os papéis Visualizador, Financeiro e Convidado não executam essas escritas. Ao criar oportunidade, o Atendente ainda precisa estar vinculado ao pipeline de destino. Criar campos personalizados exige apenas ser membro autenticado do workspace. Veja o alcance de cada papel em Permissões.

Plano: o CRM está incluído em todos os planos; o volume de contatos é limitado pelo plano — veja Limite de contatos.

Contato — criar

Campos aceitos ao cadastrar um contato manualmente.

Campo	Tipo	Restrição	Obrigatório
name	texto	—	Sim
email	e-mail	5–255 caracteres, formato e-mail	Não
telephone	texto	máx. 20, apenas dígitos com `+` opcional (`^\+?\d+$`)	Não
instagram	texto	—	Não
tagIds	lista de tags	IDs (UUID) de tags existentes	Não
customFieldValues	lista	valores de campos personalizados	Não

Contato — editar

Campos aceitos ao atualizar um contato. Todos são opcionais; enviar null limpa o campo.

Campo	Tipo	Restrição	Obrigatório
name	texto	—	Não
email	e-mail	5–255 caracteres, formato e-mail	Não
telephone	texto	máx. 20, `^\+?\d+$`	Não
address	objeto	endereço	Não
city	texto	—	Não
state	texto	—	Não
profession	texto	—	Não
language	texto	—	Não
genderIdentity	enum	`male`, `female`, `other`	Não
document	texto	—	Não
birthday	data	data (AAAA-MM-DD)	Não
isSms	booleano	—	Não
instagram	texto	—	Não
telegramUsername	texto	—	Não
linkedin	texto	—	Não
twitterX	texto	—	Não
tiktok	texto	—	Não
youtube	texto	—	Não
whatsappNumber	texto	—	Não
origin	enum	origem do contato	Não
observations	texto	—	Não

Oportunidade — criar card

Campos aceitos ao criar uma oportunidade em um pipeline.

Campo	Tipo	Restrição	Obrigatório
leadIds	lista	IDs (UUID) de contatos	Sim
pipelineId	UUID	pipeline de destino	Sim
stageId	UUID	etapa de destino	Sim
title	texto	—	Não
value	inteiro	≥ 0 (em centavos)	Não
probability	inteiro	0–100	Não
attendantIds	lista	IDs (UUID) de atendentes	Não
productIds	lista	IDs (UUID) de produtos	Não
offerIds	lista	IDs (UUID) de ofertas	Não
companyId	UUID	empresa vinculada	Não
funnelId	UUID	funil de origem	Não
priority	enum	`urgent`, `high`, `medium`, `low`, `none`	Não
temperature	enum	`hot`, `warm`, `cold`, `frozen`	Não
expectedClosingDate	texto (data)	data prevista de fechamento	Não
origin	texto	origem da oportunidade (padrão `ManualCreated`)	Não
referredBy	texto	indicado por	Não
isRecurring	booleano	oportunidade recorrente	Não
customFieldValues	lista	valores de campos personalizados	Não

Campo personalizado — configuração

Campos aceitos ao criar um campo personalizado no CRM.

Campo	Tipo	Restrição	Obrigatório
entityType	enum	`leads`, `opportunities`	Sim
fieldName	texto	1–100 caracteres	Sim
displayName	texto	1–200 caracteres	Sim
fieldType	enum	ver tabela abaixo	Sim
description	texto	máx. 500 caracteres	Não
required	booleano	—	Não
unique	booleano	—	Não
defaultValue	qualquer	valor padrão	Não
options	lista	pares `label`/`value` (para seleção)	Não
formula	texto	expressão (tipo `formula`)	Não
order	número	ordem de exibição	Não
groupName	texto	máx. 100 caracteres	Não
showInList	booleano	exibir na lista	Não
showInDetail	booleano	exibir no detalhe	Não
showInCreate	booleano	exibir na criação	Não
showOnCard	booleano	exibir no card	Não
pinned	booleano	fixar	Não
filterable	booleano	permitir filtro	Não

Tipos de campo personalizado (fieldType)

Valor	Descrição
text	Texto curto
textarea	Texto longo
number	Número
currency	Valor monetário
percentage	Porcentagem
date	Data
boolean	Verdadeiro/falso
select	Seleção única
multi_select	Seleção múltipla
radio	Opção única (rádio)
rating	Avaliação
link	Link
file	Arquivo
formula	Fórmula
json	JSON

Relacionados

Referência da API — endpoints que aceitam esses campos.
Permissões — papel exigido para cada escrita.
Importar contatos — carga em massa desses campos.
Códigos de erro — respostas de validação.

Se não funcionou

Atingiu o teto do plano ao salvar um contato → Limite de contatos.
Campo ou botão indisponível → seu papel não permite a ação; veja Sem permissão.
Valor recusado na validação → confira a restrição na tabela e os Códigos de erro.

#Campos

#Contato — criar

#Contato — editar

#Oportunidade — criar card

#Campo personalizado — configuração

#Tipos de campo personalizado (fieldType)

#Relacionados

#Se não funcionou