Referência da API

CRM e funis de venda

Empresas, funis, etapas e cards: importe em lote, mova cards entre etapas, marque ganho ou perda e registre atividades, campos e arquivos de cada card.

35 operações
URL basehttps://api.messages.ccxcompany.co
AutenticaçãoBearer com a sua chave de API

O texto técnico abaixo vem do contrato público, o openapi.json, no idioma em que o contrato foi escrito.

Lista as empresas

GET/v2/companies

Em ordem de nome, com total e paginação por limit (1–100, padrão 25) e skip. q procura pelo nome (parcial, sem diferenciar maiúsculas); se o texto for um CNPJ válido (dígito verificador conferido), com ou sem máscara, procura pelo CNPJ; um CNPJ com o dígito errado é procurado como nome. responsavelId filtra pela pessoa responsável.

Cada item traz contagens: contatos, negociosAbertos, valorAberto (soma dos negócios abertos, sem converter a moeda de cada negócio — a mesma regra do resumo do funil) e ultimaInteracao (a mais recente entre os contatos da empresa, ou null).

Permissão: crm:read.

Parâmetros

Campo	Onde	Tipo	Descrição
`q`opcional	query	`string`
`responsavelId`opcional	query	`string`
`limit`opcional	query	`integer`	Padrão:`25`
`skip`opcional	query	`integer`	Padrão:`0`

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`items`obrigatório	`object[]`
`items[].id`obrigatório	`string`
`items[].organizationId`obrigatório	`string`
`items[].nome`obrigatório	`string`
`items[].cnpj`opcional	`string`
`items[].segmento`opcional	`string`
`items[].site`opcional	`string · uri`
`items[].endereco`opcional	`string`
`items[].responsavelId`opcional	`string`
`items[].contatoPrincipalId`opcional	`string`
`items[].atributos`opcional	`object`	Atributos livres da empresa (texto, número, sim/não, nulo ou lista curta de textos).
`items[].createdById`obrigatório	`string`
`items[].createdAt`obrigatório	`string · date-time`
`items[].updatedAt`obrigatório	`string · date-time`
`items[].contagens`obrigatório	`object`
`items[].contagens.contatos`obrigatório	`integer`
`items[].contagens.negociosAbertos`obrigatório	`integer`
`items[].contagens.valorAberto`obrigatório	`number`
`items[].contagens.ultimaInteracao`obrigatório	`string \| null · date-time`
`total`obrigatório	`integer`

JSON

{  "items": [    {      "id": "string",      "organizationId": "string",      "nome": "string",      "cnpj": "string",      "segmento": "string",      "site": "https://example.com",      "endereco": "string",      "responsavelId": "string",      "contatoPrincipalId": "string",      "atributos": {},      "createdById": "string",      "createdAt": "2026-10-16T12:00:00.000Z",      "updatedAt": "2026-10-16T12:00:00.000Z",      "contagens": {        "contatos": 0,        "negociosAbertos": 0,        "valorAberto": 0,        "ultimaInteracao": "2026-10-16T12:00:00.000Z"      }    }  ],  "total": 0}

400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/v2/companies' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Cria uma empresa

POST/v2/companies

Cadastra a conta B2B a que contatos e negócios apontam. cnpj aceita com ou sem máscara (numérico ou alfanumérico, no formato da Receita) e é guardado normalizado, em maiúsculas e sem máscara; o dígito verificador é conferido.

Um CNPJ já cadastrado na organização é 409 com meta.code = CNPJ_JA_CADASTRADO — também quando dois cadastros do mesmo CNPJ chegam juntos. Empresa sem CNPJ pode repetir à vontade. contatoPrincipalId tem de ser um contato desta organização e responsavelId, um membro ativo dela (membro suspenso ou convidado que ainda não aceitou não vale): senão 422 VINCULO_INVALIDO.

atributos são conferidos contra as definições da organização (GET /v2/organizations/me/company-attribute-defs): tipo errado ou atributo obrigatório ausente é 422.

Permissão: crm:write.

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`nome`obrigatório	`string`
`cnpj`opcional	`string`
`segmento`opcional	`string`
`site`opcional	`string · uri`
`endereco`opcional	`string`
`responsavelId`opcional	`string`
`contatoPrincipalId`opcional	`string`
`atributos`opcional	`object`	Atributos livres da empresa (texto, número, sim/não, nulo ou lista curta de textos).

Exemplo completo do corpo

JSON

{  "nome": "string",  "cnpj": "string",  "segmento": "string",  "site": "https://example.com",  "endereco": "string",  "responsavelId": "string",  "contatoPrincipalId": "string",  "atributos": {}}

Respostas

201Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`organizationId`obrigatório	`string`
`nome`obrigatório	`string`
`cnpj`opcional	`string`
`segmento`opcional	`string`
`site`opcional	`string · uri`
`endereco`opcional	`string`
`responsavelId`opcional	`string`
`contatoPrincipalId`opcional	`string`
`atributos`opcional	`object`	Atributos livres da empresa (texto, número, sim/não, nulo ou lista curta de textos).
`createdById`obrigatório	`string`
`createdAt`obrigatório	`string · date-time`
`updatedAt`obrigatório	`string · date-time`
`contagens`obrigatório	`object`
`contagens.contatos`obrigatório	`integer`
`contagens.negociosAbertos`obrigatório	`integer`
`contagens.valorAberto`obrigatório	`number`
`contagens.ultimaInteracao`obrigatório	`string \| null · date-time`

JSON

{  "id": "string",  "organizationId": "string",  "nome": "string",  "cnpj": "string",  "segmento": "string",  "site": "https://example.com",  "endereco": "string",  "responsavelId": "string",  "contatoPrincipalId": "string",  "atributos": {},  "createdById": "string",  "createdAt": "2026-10-16T12:00:00.000Z",  "updatedAt": "2026-10-16T12:00:00.000Z",  "contagens": {    "contatos": 0,    "negociosAbertos": 0,    "valorAberto": 0,    "ultimaInteracao": "2026-10-16T12:00:00.000Z"  }}

400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/v2/companies' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "nome": "string"  }'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Importa empresas em lote

POST/v2/companies/import

Até 500 empresas por chamada em empresas, cada uma no formato do cadastro. Atualiza a que já existe — pelo CNPJ e, na linha sem CNPJ, pelo nome exato (diferencia maiúsculas) — e cria as outras. Uma linha que atualiza só muda os campos que ela traz; atributos só substitui os de antes quando a linha tem a chave.

Responde { criadas, atualizadas, erros }. Cada erro traz o número da linha (a posição na lista enviada, a partir de 1) e uma mensagem que diz o campo e o problema, sem repetir o valor enviado. As linhas boas entram mesmo quando outras falham.

Linha sem CNPJ cujo nome existe mais de uma vez na organização não é adivinhada: vira erro.

Permissão: crm:write.

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`empresas`obrigatório	`any[]`

Exemplo completo do corpo

JSON

{  "empresas": []}

Respostas

200Default Response
Campos e exemplo da resposta
Campo Tipo Descrição
criadasobrigatório integer
atualizadasobrigatório integer
errosobrigatório object[]
erros[].linhaobrigatório integer
erros[].mensagemobrigatório string
JSON
```
{  "criadas": 0,  "atualizadas": 0,  "erros": [    {      "linha": 1,      "mensagem": "string"    }  ]}
```
400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
422RFC 7807 problem details for VALIDATION_ERROR (422).

Campo	Tipo	Descrição
`criadas`obrigatório	`integer`
`atualizadas`obrigatório	`integer`
`erros`obrigatório	`object[]`
`erros[].linha`obrigatório	`integer`
`erros[].mensagem`obrigatório	`string`

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/v2/companies/import' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "empresas": []  }'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Lê uma empresa

GET/v2/companies/{id}

A empresa com as contagens da ficha: contatos, negócios abertos, valor em aberto, última interação e os GANHOS — valorGanho (a soma do valor dos negócios ganhos, sem converter a moeda de cada negócio, a mesma regra do resumo do funil, em reais arredondados em centavos) e negociosGanhos.

Permissão: crm:read.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`organizationId`obrigatório	`string`
`nome`obrigatório	`string`
`cnpj`opcional	`string`
`segmento`opcional	`string`
`site`opcional	`string · uri`
`endereco`opcional	`string`
`responsavelId`opcional	`string`
`contatoPrincipalId`opcional	`string`
`atributos`opcional	`object`	Atributos livres da empresa (texto, número, sim/não, nulo ou lista curta de textos).
`createdById`obrigatório	`string`
`createdAt`obrigatório	`string · date-time`
`updatedAt`obrigatório	`string · date-time`
`contagens`obrigatório	`object`
`contagens.contatos`obrigatório	`integer`
`contagens.negociosAbertos`obrigatório	`integer`
`contagens.valorAberto`obrigatório	`number`
`contagens.ultimaInteracao`obrigatório	`string \| null · date-time`
`contagens.valorGanho`obrigatório	`number`
`contagens.negociosGanhos`obrigatório	`integer`

JSON

{  "id": "string",  "organizationId": "string",  "nome": "string",  "cnpj": "string",  "segmento": "string",  "site": "https://example.com",  "endereco": "string",  "responsavelId": "string",  "contatoPrincipalId": "string",  "atributos": {},  "createdById": "string",  "createdAt": "2026-10-16T12:00:00.000Z",  "updatedAt": "2026-10-16T12:00:00.000Z",  "contagens": {    "contatos": 0,    "negociosAbertos": 0,    "valorAberto": 0,    "ultimaInteracao": "2026-10-16T12:00:00.000Z",    "valorGanho": 0,    "negociosGanhos": 0  }}

400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/v2/companies/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Edita uma empresa

PATCH/v2/companies/{id}

Só muda o que vem no corpo; null limpa um campo opcional (cnpj, segmento, site, endereco, responsavelId, contatoPrincipalId). atributos, quando vem, substitui os de antes por inteiro — um PATCH só do nome não toca nos atributos.

Trocar o cnpj para o de outra empresa da organização é 409 CNPJ_JA_CADASTRADO. Responde a empresa com as contagens da ficha (as do GET).

responsavelId e contatoPrincipalId só são conferidos quando MUDAM: reenviar o mesmo de sempre passa mesmo que a pessoa tenha saído da organização. O novo responsavelId tem de ser membro ativo da organização (422 VINCULO_INVALIDO).

atributos são conferidos contra as definições da organização (GET /v2/organizations/me/company-attribute-defs): tipo errado ou atributo obrigatório ausente é 422.

Permissão: crm:write.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`nome`opcional	`string`
`cnpj`opcional	`string \| null`
`segmento`opcional	`string \| null`
`site`opcional	`string \| null · uri`
`endereco`opcional	`string \| null`
`responsavelId`opcional	`string \| null`
`contatoPrincipalId`opcional	`string \| null`
`atributos`opcional	`object`	Atributos livres da empresa (texto, número, sim/não, nulo ou lista curta de textos).

Exemplo completo do corpo

JSON

{  "nome": "string",  "cnpj": "string",  "segmento": "string",  "site": "https://example.com",  "endereco": "string",  "responsavelId": "string",  "contatoPrincipalId": "string",  "atributos": {}}

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`id`obrigatório	`string`
`organizationId`obrigatório	`string`
`nome`obrigatório	`string`
`cnpj`opcional	`string`
`segmento`opcional	`string`
`site`opcional	`string · uri`
`endereco`opcional	`string`
`responsavelId`opcional	`string`
`contatoPrincipalId`opcional	`string`
`atributos`opcional	`object`	Atributos livres da empresa (texto, número, sim/não, nulo ou lista curta de textos).
`createdById`obrigatório	`string`
`createdAt`obrigatório	`string · date-time`
`updatedAt`obrigatório	`string · date-time`
`contagens`obrigatório	`object`
`contagens.contatos`obrigatório	`integer`
`contagens.negociosAbertos`obrigatório	`integer`
`contagens.valorAberto`obrigatório	`number`
`contagens.ultimaInteracao`obrigatório	`string \| null · date-time`
`contagens.valorGanho`obrigatório	`number`
`contagens.negociosGanhos`obrigatório	`integer`

JSON

{  "id": "string",  "organizationId": "string",  "nome": "string",  "cnpj": "string",  "segmento": "string",  "site": "https://example.com",  "endereco": "string",  "responsavelId": "string",  "contatoPrincipalId": "string",  "atributos": {},  "createdById": "string",  "createdAt": "2026-10-16T12:00:00.000Z",  "updatedAt": "2026-10-16T12:00:00.000Z",  "contagens": {    "contatos": 0,    "negociosAbertos": 0,    "valorAberto": 0,    "ultimaInteracao": "2026-10-16T12:00:00.000Z",    "valorGanho": 0,    "negociosGanhos": 0  }}

400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X PATCH 'https://api.messages.ccxcompany.co/v2/companies/<id>' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Apaga uma empresa

DELETE/v2/companies/{id}

Apaga a empresa. Os contatos e os negócios que apontavam para ela ficam, sem a empresa (e o contato, sem o papel nela). Tudo acontece numa transação: se algo falhar, nada é desfeito. Não dá para desfazer.

Fica no log de auditoria como company.deleted (quem apagou e quantos contatos e negócios foram desvinculados; nunca o nome, o CNPJ nem o endereço).

Permissão: crm:delete.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

204Default Response
400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X DELETE 'https://api.messages.ccxcompany.co/v2/companies/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Lista as definições de atributos das empresas

GET/v2/organizations/me/company-attribute-defs

O dicionário que confere Company.atributos: chave, tipo (string, number, boolean ou date), rótulo e se é obrigatório. { defs: [] } para a organização que ainda não definiu nenhum — aí todo atributo é livre. É separado dos atributos do contato.

Permissão: crm:read.

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`defs`obrigatório	`object[]`
`defs[].key`obrigatório	`string`
`defs[].type`obrigatório	`string`	Valores:`stringnumberbooleandate`
`defs[].label`opcional	`string`
`defs[].required`opcional	`boolean`	Padrão:`false`

JSON

{  "defs": [    {      "key": "string",      "type": "string",      "label": "string",      "required": false    }  ]}

401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/v2/organizations/me/company-attribute-defs' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Substitui as definições de atributos das empresas

PUT/v2/organizations/me/company-attribute-defs

Substituição completa: manda a lista inteira em defs (até 50) e some a chave que ficar de fora. Chave repetida é 409. As empresas que já existem não são alteradas; a regra vale nas próximas gravações.

A propriedade que parece documento, senha, cartão ou token (pela chave OU pelo rótulo) e ainda guarda valores nas empresas não sai da lista nem muda de rótulo: 409 com meta.code = PROPRIEDADE_SENSIVEL_EM_USO (tire os valores antes). Se a conferência não couber em 5 s, 503.

Permissão: crm:write.

Corpo da requisição`application/json`

Campo	Tipo	Descrição
`defs`obrigatório	`object[]`
`defs[].key`obrigatório	`string`
`defs[].type`obrigatório	`string`	Valores:`stringnumberbooleandate`
`defs[].label`opcional	`string`
`defs[].required`opcional	`boolean`	Padrão:`false`

Exemplo completo do corpo

JSON

{  "defs": [    {      "key": "string",      "type": "string",      "label": "string",      "required": false    }  ]}

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`defs`obrigatório	`object[]`
`defs[].key`obrigatório	`string`
`defs[].type`obrigatório	`string`	Valores:`stringnumberbooleandate`
`defs[].label`opcional	`string`
`defs[].required`opcional	`boolean`	Padrão:`false`

JSON

{  "defs": [    {      "key": "string",      "type": "string",      "label": "string",      "required": false    }  ]}

400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X PUT 'https://api.messages.ccxcompany.co/v2/organizations/me/company-attribute-defs' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "defs": [      {        "key": "string",        "type": "string"      }    ]  }'

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

List pipelines

GET/pipelines

contagem=true adds cardCounts (pipeline id → number of cards) and openStageCounts (pipeline id → number of stages that are neither won nor lost), archived pipelines included when includeArchived=true.

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/pipelines' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Create a pipeline

POST/pipelines

tipo defaults to vendas; cobranca and onboarding are not available yet: 422 with meta.code = TIPO_AINDA_NAO_DISPONIVEL. The type never changes afterwards. Each seeded stage may carry probabilidade (0–100), tempoMaximoDias (1–365) and camposObrigatorios — only the standard keys valor, dataPrevista, contato, responsavel here (422 CAMPO_DESCONHECIDO otherwise).

motivos (lost reasons) require a lost stage among stages: 409 with meta.code = MOTIVOS_SEM_ETAPA_DE_PERDA; a blank reason is 422 MOTIVO_VAZIO.

Respostas

201Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/pipelines' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Get a pipeline board

GET/pipelines/{id}

Stages, the first page of cards per stage and the board summary, all under the same filters. stageWeightedTotals is, per stage, the sum of value × win probability (the card's own, else the stage's; won stages count 100 %, lost stages 0 %).

metrics adds the current month (America/Sao_Paulo calendar): previstoPonderadoMes (open cards with dataPrevista in the month, weighted), ganhosNoMesValor/ganhosNoMesQtd (won cards closed in the month) and cicloMedioDias (average days from creation to win; absent when there is no win).

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/pipelines/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Update a pipeline

PATCH/pipelines/{id}

The pipeline type never changes: tipo in the body is 409 with meta.code = TIPO_IMUTAVEL. motivos (lost reasons; []/null clears) require a lost stage: 409 MOTIVOS_SEM_ETAPA_DE_PERDA. An archived pipeline only accepts status: active (restore); anything else is 404.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X PATCH 'https://api.messages.ccxcompany.co/pipelines/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Archive a pipeline

DELETE/pipelines/{id}

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

204Default Response
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X DELETE 'https://api.messages.ccxcompany.co/pipelines/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Create a stage

POST/pipelines/{id}/stages

camposObrigatorios (what a card needs to ENTER the stage) takes the standard keys valor, dataPrevista, contato, responsavel or ids of the pipeline's fields; anything else is 422 with meta.code = CAMPO_DESCONHECIDO (meta.chaves).

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

201Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/pipelines/<id>/stages' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

List a stage's cards (paginated)

GET/pipelines/{id}/stages/{stageId}/cards

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`
`stageId`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/pipelines/<id>/stages/<stageId>/cards' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Update a stage

PATCH/pipelines/{id}/stages/{stageId}

probabilidade (0–100) and tempoMaximoDias (1–365) accept null to clear; camposObrigatorios takes the standard keys or the pipeline's field ids ([] clears; unknown keys are 422 CAMPO_DESCONHECIDO). The last lost stage of a pipeline with motivos cannot stop being a lost stage: 409 with meta.code = ETAPA_DE_PERDA_COM_MOTIVOS.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`
`stageId`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X PATCH 'https://api.messages.ccxcompany.co/pipelines/<id>/stages/<stageId>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Delete a stage

DELETE/pipelines/{id}/stages/{stageId}

Only an empty stage can be deleted: 409 with meta.code = ETAPA_COM_CARDS. The last lost stage of a pipeline with motivos stays: 409 ETAPA_DE_PERDA_COM_MOTIVOS.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`
`stageId`obrigatório	caminho	`string`

Respostas

204Default Response
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X DELETE 'https://api.messages.ccxcompany.co/pipelines/<id>/stages/<stageId>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Reorder stages

POST/pipelines/{id}/stages/reorder

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
[  {}]
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/pipelines/<id>/stages/reorder' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

List the cards of a contact or of a company

GET/cards

Exactly one of contactId or companyId (none or both is 422 with meta.code = CONTATO_OU_EMPRESA). contactId matches the card's main contact OR any of its outrosContatos. Optional pipelineId and status narrow the list. Newest first (createdAt), up to limit (1–50, default 50); temMais: true means there are more cards than returned.

Each card carries pipelineName and stageName (absent when the pipeline or stage no longer exists). A contact or company of another organization simply returns an empty list.

Permissão: crm:read.

Parâmetros

Campo	Onde	Tipo	Descrição
`contactId`opcional	query	`string`
`companyId`opcional	query	`string`
`pipelineId`opcional	query	`string`
`status`opcional	query	`string`	Valores:`openwonlost`
`limit`opcional	query	`integer`

Respostas

200Default Response

Campos e exemplo da resposta

Campo	Tipo	Descrição
`items`obrigatório	`object[]`
`items[].id`obrigatório	`string`
`items[].organizationId`obrigatório	`string`
`items[].pipelineId`obrigatório	`string`
`items[].stageId`obrigatório	`string`
`items[].order`obrigatório	`integer`
`items[].title`obrigatório	`string`
`items[].description`opcional	`string`
`items[].value`opcional	`number`
`items[].currency`opcional	`string`
`items[].contactId`opcional	`string`
`items[].conversationId`opcional	`string`
`items[].origem`opcional	`object`
`items[].origem.canal`opcional	`string`
`items[].origem.regraId`opcional	`string`
`items[].origem.via`opcional	`string`	Valores:`linkanuncio_metacodigo_fixo`
`items[].origem.fonte`opcional	`string`	Valores:`googlemetatiktokoutra`
`items[].origem.fonteRotulo`opcional	`string`
`items[].origem.campanha`opcional	`string`
`items[].origem.grupo`opcional	`string`
`items[].origem.anuncio`opcional	`string`
`items[].origem.palavraChave`opcional	`string`
`items[].origem.toqueId`opcional	`string`
`items[].origem.em`opcional	`string · date-time`
`items[].companyId`opcional	`string`
`items[].outrosContatos`opcional	`string[]`
`items[].assigneeId`opcional	`string`
`items[].tags`opcional	`string[]`	Padrão:`[]`
`items[].dueDate`opcional	`string · date-time`
`items[].dataPrevista`opcional	`string · date-time`
`items[].probabilidade`opcional	`integer`
`items[].fechadoEm`opcional	`string · date-time`
`items[].motivoDesfecho`opcional	`string`
`items[].customFields`opcional	`object`	Padrão:`{}`
`items[].fieldValues`opcional	`object`
`items[].files`opcional	`object[]`
`items[].files[].id`obrigatório	`string`
`items[].files[].name`obrigatório	`string`
`items[].files[].size`obrigatório	`integer`
`items[].files[].contentType`obrigatório	`string`
`items[].files[].uploadedById`opcional	`string`
`items[].files[].uploadedAt`obrigatório	`string · date-time`
`items[].status`obrigatório	`string`	Valores:`openwonlost`
`items[].stageEnteredAt`obrigatório	`string · date-time`
`items[].createdById`obrigatório	`string`
`items[].createdAt`obrigatório	`string · date-time`
`items[].updatedAt`obrigatório	`string · date-time`
`items[].pipelineName`opcional	`string`
`items[].stageName`opcional	`string`
`temMais`obrigatório	`boolean`

JSON

{  "items": [    {      "id": "string",      "organizationId": "string",      "pipelineId": "string",      "stageId": "string",      "order": 0,      "title": "string",      "description": "string",      "value": 0,      "currency": "string",      "contactId": "string",      "conversationId": "string",      "origem": {        "canal": "string",        "regraId": "string",        "via": "link",        "fonte": "google",        "fonteRotulo": "string",        "campanha": "string",        "grupo": "string",        "anuncio": "string",        "palavraChave": "string",        "toqueId": "string",        "em": "2026-10-16T12:00:00.000Z"      },      "companyId": "string",      "outrosContatos": [        "string"      ],      "assigneeId": "string",      "tags": [],      "dueDate": "2026-10-16T12:00:00.000Z",      "dataPrevista": "2026-10-16T12:00:00.000Z",      "probabilidade": 0,      "fechadoEm": "2026-10-16T12:00:00.000Z",      "motivoDesfecho": "string",      "customFields": {},      "fieldValues": {},      "files": [        {          "id": "string",          "name": "string",          "size": 0,          "contentType": "string",          "uploadedById": "string",          "uploadedAt": "2026-10-16T12:00:00.000Z"        }      ],      "status": "open",      "stageEnteredAt": "2026-10-16T12:00:00.000Z",      "createdById": "string",      "createdAt": "2026-10-16T12:00:00.000Z",      "updatedAt": "2026-10-16T12:00:00.000Z",      "pipelineName": "string",      "stageName": "string"    }  ],  "temMais": true}

401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/cards' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Create a card

POST/cards

The initial stage's required fields apply: 409 with meta.code = CAMPOS_OBRIGATORIOS (meta.campos lists the missing field labels). fieldValues keys must be fields of the pipeline: 422 with meta.code = CAMPO_DESCONHECIDO (meta.chaves lists the unknown keys).

companyId (the company of the deal), contactId (the main contact) and outrosContatos (up to 20 more contacts, never repeating each other nor contactId) must belong to this organization: 422 with meta.code = VINCULO_INVALIDO otherwise.

When conversationId is given and that conversation (of this organization) came in through an ad or a WhatsApp link, the card is born with origem (via, fonte, campanha, grupo, anuncio, palavraChave, toqueId, em), a copy of the conversation's last origin; it never changes afterwards and is not accepted in the body of POST/PATCH.

The card keeps origem when the conversation is deleted.

Respostas

201Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/cards' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Bulk-import cards into a pipeline

POST/cards/import

Imports up to 500 cards per request into an existing pipeline. Each card is a contact in a stage; contactPhone (E.164) links to the migrated contact, stageId must belong to the pipeline. Writes directly — no `card.created` event is emitted (migration load; the board refreshes on its own). Idempotency is the caller's responsibility (dedup by source id).

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/cards/import' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Get a card

GET/cards/{id}

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/cards/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Update a card

PATCH/cards/{id}

status: won|lost marks the outcome. When the pipeline has a won/lost stage, the card moves to the first one, with the same rules as POST /cards/{id}/desfecho (without motivo); when it has none, the status changes in place (legacy pipelines). status: open on a card marked won/lost in an open stage reopens it and clears fechadoEm/motivoDesfecho.

409 with meta.code = CAMPOS_OBRIGATORIOS (the won/lost stage's required fields; meta.campos lists them), MOTIVO_OBRIGATORIO (lost in a pipeline with motivos: use POST /cards/{id}/desfecho), SEM_ETAPA_DE_DESFECHO (the card sits in a stage of the other outcome and the pipeline has no stage for this one) or USE_REABRIR (status: open on a card in a won/lost stage: move it to an open stage instead).

companyId: null unlinks the company; outrosContatos replaces the list ([] clears). A new companyId/contactId/outrosContatos entry must belong to this organization, and the main contact never repeats in outrosContatos — checked against the STORED card on a partial PATCH: 422 with meta.code = VINCULO_INVALIDO. To promote one of outrosContatos to main contact, send both fields in the same PATCH.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X PATCH 'https://api.messages.ccxcompany.co/cards/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Delete a card

DELETE/cards/{id}

Hard-delete. Removes the card together with its activity history and its attached files (the bytes in the media store). Not reversible. Recorded in the audit log as card.deleted (who, and how many activities and files went with it; never the title).

A file whose bytes cannot be removed from the store does not keep the card alive: the card is deleted and the audit entry counts it in arquivosComFalha.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

204Default Response
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X DELETE 'https://api.messages.ccxcompany.co/cards/<id>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Move a card to another stage or position

POST/cards/{id}/move

Entering a stage enforces its rules. 409 with meta.code = CAMPOS_OBRIGATORIOS (meta.campos lists the missing field labels) or MOTIVO_OBRIGATORIO (a lost stage of a pipeline that defines motivos requires motivo).

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/cards/<id>/move' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Mark a card as won or lost

POST/cards/{id}/desfecho

Moves the card to the pipeline's first won (ganho) or lost (perdido) stage, with the same rules as a move. 409 with meta.code = SEM_ETAPA_DE_DESFECHO (no such stage), CAMPOS_OBRIGATORIOS or MOTIVO_OBRIGATORIO.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
409RFC 7807 problem details for CONFLICT (409).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/cards/<id>/desfecho' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

List a card's activity history

GET/cards/{id}/activities

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/cards/<id>/activities' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Log a manual activity on a card

POST/cards/{id}/activities

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

201Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/cards/<id>/activities' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Add a custom activity type to a pipeline

POST/pipelines/{id}/activity-types

"Sistema" and "Arquivo" (case- and accent-insensitive) are reserved for platform events and return 422 with meta.code = "TIPO_DE_ATIVIDADE_RESERVADO".

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/pipelines/<id>/activity-types' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Add a typed field to a pipeline

POST/pipelines/{id}/fields

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/pipelines/<id>/fields' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Remove a field from a pipeline

DELETE/pipelines/{id}/fields/{fieldId}

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`
`fieldId`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X DELETE 'https://api.messages.ccxcompany.co/pipelines/<id>/fields/<fieldId>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Set a card's field value

PUT/cards/{id}/fields/{fieldId}

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`
`fieldId`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
{}
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X PUT 'https://api.messages.ccxcompany.co/cards/<id>/fields/<fieldId>' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Attach a file to a card

POST/cards/{id}/files

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`

Respostas

201Default Response
Campos e exemplo da resposta
JSON
```
{}
```
400RFC 7807 problem details for BAD_REQUEST (400).
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/cards/<id>/files' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Download a card file

GET/cards/{id}/files/{fileId}/content

Imagem (png, jpeg, gif, webp) e PDF abrem como estão, desde que a extensão do nome combine com o tipo; qualquer outro tipo vem como application/octet-stream com Content-Disposition: attachment, e o tipo gravado no upload fica em card.files[].contentType.

Files outside that list — including HTML, SVG and XML — are never served inline. A type inside the list is served normalized (image/jpg becomes image/jpeg). Every response carries X-Content-Type-Options: nosniff and a restrictive Content-Security-Policy.

Parâmetros

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	`string`
`fileId`obrigatório	caminho	`string`

Respostas

200O arquivo. Imagem (png, jpeg, gif, webp) e PDF com a extensão do nome certa saem com o tipo próprio; qualquer outro tipo sai como application/octet-stream com Content-Disposition: attachment. O tipo gravado no upload fica em card.files[].contentType.
Campos e exemplo da resposta
JSON
```
null
```
404Arquivo ou card não encontrado.

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl 'https://api.messages.ccxcompany.co/cards/<id>/files/<fileId>/content' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Reorder cards within a stage

POST/stages/{stageId}/cards/reorder

Parâmetros

Campo	Onde	Tipo	Descrição
`stageId`obrigatório	caminho	`string`

Respostas

200Default Response
Campos e exemplo da resposta
JSON
```
[  {}]
```
401RFC 7807 problem details for UNAUTHORIZED (401).
403RFC 7807 problem details for FORBIDDEN (403).
404RFC 7807 problem details for NOT_FOUND (404).
422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL

curl -X POST 'https://api.messages.ccxcompany.co/stages/<stageId>/cards/reorder' \  -H "Authorization: Bearer $CCX_API_KEY"

Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Travou em alguma rota? Fale com quem mantém a API.

Criar conta grátis Falar com vendas

Criando a conta pelo site, você ganha R$ 10 de crédito de teste.

CRM e funis de venda

Parâmetros

Respostas

Exemplo em curl

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Respostas

Exemplo em curl

Corpo da requisiçãoapplication/json

Respostas

Exemplo em curl

Respostas

Exemplo em curl

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Respostas

Exemplo em curl

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Exemplo em curl

Parâmetros

Respostas

Corpo da requisição`application/json`

Corpo da requisição`application/json`

Corpo da requisição`application/json`

Corpo da requisição`application/json`