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 '{
"context": "deal",
"mask": "",
"name": "Campo Personalizado Cubo",
"options": [
"New 1",
"New 2"
],
"showCard": false,
"status": "active",
"type": "selectbox"
}'Response Response Example
{
"name": "Campo Personalizado Cubo",
"context": "deal",
"type": "selectbox",
"showCard": false,
"companyId": 91,
"status": "active",
"createdAt": "2025-06-23T09:56:00.758-03:00",
"updatedAt": "2025-06-23T09:56:00.758-03:00",
"id": 315387,
"options": [
{
"id": 30803146,
"value": "New 1",
"customfieldId": 31514387,
"createdAt": "2025-06-23T09:56:00.000-03:00",
"updatedAt": "2025-06-23T09:56:00.000-03:00"
},
{
"id": 308037,
"value": "New 2",
"customfieldId": 31514387,
"createdAt": "2025-06-23T09:56:00.000-03:00",
"updatedAt": "2025-06-23T09:56:00.000-03:00"
}
]
}Requisição
Parâmetros Header
Content-Type
string
opcional
Exemplo:
application/json
Parâmetros Bodyapplication/json
Respostas
Modificado em 2025-06-23 12:56:06