Criar novo campo personalizado
POST
https://api.cubosuite.com.br/customfields
Descrição
Campos do tipo
state ou city são únicos por empresa e não podem ser duplicados.Campos do tipo
selectbox podem receber opções associadas.Campos
| Campo | Tipo | Descrição |
|---|---|---|
| name | string | Nome do campo personalizado. Obrigatório e único por empresa. |
| mask | string (opcional) | Máscara para formatação do campo (ex: CPF, telefone). |
| context | enum | Contexto ao qual o campo pertence: people, deal, ou organization. |
| type | enum | Tipo do campo: text, selectbox, datetime, city, ou state. |
| options | array de strings | Lista de opções para campos do tipo selectbox. Obrigatório neste caso. |
| showCard | boolean (opcional) | Indica se o campo deve ser exibido em cartões. |
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cubosuite.com.br/customfields' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Status do Pedido",
"mask": null,
"context": "deal",
"type": "selectbox",
"options": ["Pendente", "Em andamento", "Concluído"],
"showCard": true
}'Response Response Example
{}Requisição
Parâmetros Header
Content-Type
string
opcional
Exemplo:
application/json
Parâmetros Bodyapplication/json
Respostas
Modificado em 2025-06-16 14:41:02