CUBO CRM
  1. Campo Personalizado
CUBO CRM
  • Comece por aqui
  • Atividade
    • Listar todas as atividades
      GET
    • Criar nova atividade
      POST
    • Obter atividade por ID
      GET
    • Atualizar atividade
      PUT
    • Excluir atividade
      DELETE
  • Anotação
    • Criar nova anotação
      POST
    • Obter anotação por ID
      GET
    • Atualizar anotação
      PUT
    • Excluir anotação
      DELETE
  • Chave de API
    • Listar todas as chaves de API
      GET
    • Criar nova chave de API
      POST
    • Obter chave de API por ID
      GET
    • Atualizar chave de API
      PUT
    • Excluir chave de API
      DELETE
  • Categoria
    • Listar todas as categorias
      GET
    • Criar nova categoria
      POST
    • Obter categoria por ID
      GET
    • Atualizar categoria
      PUT
    • Excluir categoria
      DELETE
  • Empresa
    • Obter empresa
    • Atualizar empresa
  • Campo Personalizado
    • Listar todos os campos personalizados
      GET
    • Criar novo campo personalizado
      POST
    • Obter campo personalizado por ID
      GET
    • Atualizar campo personalizado
      PUT
    • Excluir campo personalizado
      DELETE
  • Negociação
    • Listar todos os negócios
    • Criar novo negócio
    • Obter negócio por ID
    • Atualizar negócio
    • Excluir negócio
    • Transborda uma negociação específica
  • Dominio
    • Listar todos os domínios
    • Criar novo domínio
    • Obter domínio por ID
    • Excluir domínio
  • Motivo de Perda
    • Listar todos os motivos de perda
    • Criar motivo de perda
    • Obter motivo de perda por ID
    • Atualizar motivo de perda
    • Excluir motivo de perda
  • Organização
    • Listar todas as organizações
    • Criar nova organização
    • Obter organização por ID
    • Atualizar organização
    • Excluir organização
  • Pessoa
    • Listar todas as pessoas
    • Criar nova pessoa
    • Obter pessoa por ID
    • Atualizar pessoa
    • Excluir pessoa
  • Funil
    • Listar todos os funis
    • Criar novo funil
    • Listar funil por ID
    • Atualizar Funil
    • Excluir funil
  • Produto
    • Listar todos os produtos
    • Criar novo produto
    • Obter produto por ID
    • Atualizar produto
    • Excluir produto
  • Proposta
    • Listar todos as propostas
    • Criar proposta para negociação pelo ID
    • Obter proposta por ID
    • Atualizar proposta
  • Estágio
    • Buscar todos os estágios do funil pelo ID
    • Criar estágios
    • Obter estágios por ID
    • Atualizar estágio
    • Excluir estágio
  • Modelo
    • Listar todos os modelos de mensagem
    • Criar modelo de mensagem
    • Criar modelo de mensagem para negócio pelo ID
    • Obter modelo de mensagem por ID
    • Atualizar modelo de mensagem
    • Excluir modelo de mensagem
  • Webhooks
    • Receber dados do BotConversa para criação
    • Receber dados do BotConversa para atualização
    • Receber dados do ManyChat para criação
    • Receber dados do ManyChat para atualização
  1. Campo Personalizado

Criar novo campo personalizado

POST
https://api.cubosuite.com.br/customfields
Descrição#
Cria um novo campo personalizado para a empresa do usuário autenticado.
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#
CampoTipoDescrição
namestringNome do campo personalizado. Obrigatório e único por empresa.
maskstring (opcional)Máscara para formatação do campo (ex: CPF, telefone).
contextenumContexto ao qual o campo pertence: people, deal, ou organization.
typeenumTipo do campo: text, selectbox, datetime, city, ou state.
optionsarray de stringsLista de opções para campos do tipo selectbox. Obrigatório neste caso.
showCardboolean (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

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Header
Content-Type
string 
opcional
Exemplo:
application/json
Parâmetros Bodyapplication/json
name
string 
requerido
context
string 
requerido
type
string 
requerido
showCard
boolean 
requerido
Examples

Respostas

🟢200Success
application/json
Body
name
string 
requerido
context
string 
requerido
type
string 
requerido
showCard
boolean 
requerido
companyId
integer 
requerido
status
string 
requerido
createdAt
string 
requerido
updatedAt
string 
requerido
id
integer 
requerido
options
array [object {5}] 
requerido
id
integer 
requerido
value
string 
requerido
customfieldId
integer 
requerido
createdAt
string 
requerido
updatedAt
string 
requerido
Modificado em 2025-06-23 12:56:06
Página anterior
Listar todos os campos personalizados
Próxima página
Obter campo personalizado por ID
Built with