Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Cria um novo campo personalizado para contatos, empresas ou negócios.
POST /v1/custom-fields
write:custom_fields
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
key | string | Sim | Chave única. Apenas minúsculas, dígitos e _, iniciando com letra. Máx. 50 |
label | string | Sim | Rótulo de exibição. Máx. 100 |
type | string | Sim | Tipo do campo (ver tabela abaixo) |
entity | string | Sim | contact, company ou deal |
options | array | Não | Opções para select/multiselect. Strings ou {value, label} |
default_value | any | Não | Valor padrão |
required | boolean | Não | Se é obrigatório |
| Tipo | Descrição |
|---|---|
text | Texto curto |
textarea | Texto longo |
number | Número |
currency | Valor monetário |
date | Data |
datetime | Data e hora |
boolean | Verdadeiro/falso |
select | Seleção única |
multiselect | Seleção múltipla |
url | URL |
email | |
phone | Telefone |
curl -X POST https://api.socialsell.ai/v1/custom-fields \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{
"key": "origem_lead",
"label": "Origem do Lead",
"type": "select",
"entity": "contact",
"options": ["Site", "Indicação", "Evento", "Anúncio"]
}'
HTTP 201 com o campo criado.
key, type e entity não podem ser alterados após a criação. Defina-os com cuidado.keykey é o identificador do campo dentro do objeto custom_fields — e é imutável depois de criada.
| Regra | Valor |
|---|---|
| Formato | ^[a-z][a-z0-9_]*$ — começa com letra minúscula; depois, minúsculas, dígitos e _ |
| Tamanho | Até 50 caracteres |
| Unicidade | Por entidade. cpf em contact e cpf em company convivem |
cpf, data_nascimento, nivel_2 · ❌ CPF, 2_via, data-nascimento, data nascimento
| Código | Status | Descrição |
|---|---|---|
VALIDATION_ERROR | 400 | Corpo inválido — inclusive key fora do formato |
DUPLICATE_KEY | 409 | Já existe campo com essa key nesta entidade |