Pular para o conteúdo

API v1 · todos os planos

Integre o Rumo CRM ao seu sistema

Leia e grave contatos, negócios e conversas do Rumo CRM a partir do seu sistema.

Abrir a referência Baixar a coleção do Postman

Endereço base

https://rumocrm.com/api/v1

Primeiro pedido em três passos

  1. 1. Crie um token

    No Rumo CRM, abra Configurações → API e integrações, dê um nome ao token e marque só os escopos de que a integração precisa. Ele aparece uma vez: guarde num cofre de segredos.

    Abrir API e integrações

  2. 2. Envie no cabeçalho

    Todo pedido leva Authorization: Bearer <token>. O token age com o seu papel: o gerente vê a empresa inteira, o vendedor só o que é dele.

    Autenticação e escopos

  3. 3. Faça o pedido

    A resposta é JSON. Listas vêm em páginas com nextCursor; todo erro tem o mesmo formato e um code estável.

    Testar na referência
Terminal
curl "https://rumocrm.com/api/v1/contacts?limit=1" \
  -H "Authorization: Bearer $RUMO_TOKEN"

O que dá para fazer

Contatos

Pessoas com quem a sua empresa fala.

  • GETListar contatos/contacts
  • POSTCriar ou atualizar contato/contacts
  • GETVer contato/contacts/{id}
  • PATCHEditar contato/contacts/{id}

Conversas

Conversas do inbox (WhatsApp, Instagram, LinkedIn e e-mail), as mensagens e os canais conectados.

  • GETListar canais/channels
  • GETListar conversas/conversations
  • GETVer conversa/conversations/{id}
  • GETListar mensagens da conversa/conversations/{id}/messages
  • POSTEnviar mensagem na conversa/conversations/{id}/messages
  • GETVer mensagem/conversations/{id}/messages/{messageId}

Empresas

Clientes pessoa jurídica, com CNPJ, ligados a contatos e negócios.

  • GETListar empresas/companies
  • POSTCriar empresa/companies
  • GETVer empresa/companies/{id}
  • PATCHEditar empresa/companies/{id}
  • DELETEDesativar empresa/companies/{id}

Funis

Funis de vendas e as etapas (colunas do quadro) de cada um.

  • GETListar funis/pipelines
  • GETVer um funil/pipelines/{id}
  • GETListar as etapas de um funil/pipelines/{id}/stages

Negócios

Oportunidades de venda, cada uma numa etapa de um funil.

  • GETListar negócios/deals
  • POSTCriar negócio/deals
  • GETVer negócio/deals/{id}
  • PATCHEditar negócio/deals/{id}
  • DELETEApagar negócio/deals/{id}
  • POSTMover negócio de etapa/deals/{id}/move
  • POSTGanhar negócio/deals/{id}/win
  • POSTPerder negócio/deals/{id}/lose
  • GETListar produtos do negócio/deals/{id}/products
  • PUTTrocar os produtos do negócio/deals/{id}/products

Política de versão

A v1 só muda de forma aditiva. Podem surgir a qualquer momento: campos novos nas respostas, parâmetros opcionais, endpoints, códigos de erro (code) e cabeçalhos. Nenhum campo é removido ou renomeado e nenhum tipo muda. Uma mudança incompatível vira /api/v2, com aviso antes. Por isso, seu código deve ignorar campos que não conhece.