API do Rumo CRM
Endereço base https://rumocrm.com/api/v1
A versão interativa, com exemplos de código e teste no navegador, carrega em seguida.
Atividades
- GETListar tipos de atividade
/activity-types - GETListar tarefas
/tasks - POSTCriar tarefa
/tasks - GETVer tarefa
/tasks/{id} - PATCHEditar tarefa
/tasks/{id} - DELETEApagar tarefa
/tasks/{id} - POSTConcluir tarefa
/tasks/{id}/complete - GETListar notas e registros
/notes - POSTRegistrar nota
/notes - GETHistórico do negócio
/activities
Catálogos
- GETListar usuários
/users - GETListar produtos
/products - GETListar motivos de perda
/lost-reasons - GETListar campos personalizados
/custom-fields - GETListar tags
/tags - GETListar origens de lead
/lead-sources
Conta
- GETVer o token e a empresa
/me
Contatos
- GETListar contatos
/contacts - POSTCriar ou atualizar contato
/contacts - POSTCriar ou atualizar contatos em lote
/contacts/batch - GETVer contato
/contacts/{id} - PATCHEditar contato
/contacts/{id} - POSTRegistrar descadastro do contato
/contacts/{id}/opt-out - DELETEDesfazer o descadastro do contato
/contacts/{id}/opt-out
Conversas
- GETListar canais
/channels - GETListar conversas
/conversations - POSTIniciar conversa com um template
/conversations - GETVer conversa
/conversations/{id} - PATCHAtribuir, fechar, arquivar ou reabrir conversa
/conversations/{id} - GETListar mensagens da conversa
/conversations/{id}/messages - POSTEnviar mensagem na conversa
/conversations/{id}/messages - GETVer mensagem
/conversations/{id}/messages/{messageId} - DELETECancelar mensagem agendada
/conversations/{id}/messages/{messageId} - GETListar templates aprovados do canal
/channels/{id}/templates - POSTValidar template e obter prévia
/channels/{id}/templates/validate - POSTCriar credencial de homologação
/sandbox/tokens - POSTSimular evento de integração
/sandbox/simulations - POSTIniciar upload de mídia
/media/uploads - PUTEnviar parte de mídia
/media/uploads/{id}/parts/{index} - POSTFinalizar upload de mídia
/media/uploads/{id}/complete
Empresas
- GETListar empresas
/companies - POSTCriar empresa
/companies - GETVer empresa
/companies/{id} - PATCHEditar empresa
/companies/{id} - DELETEDesativar empresa
/companies/{id}
Funis
- GETListar funis
/pipelines - GETVer um funil
/pipelines/{id} - GETListar as etapas de um funil
/pipelines/{id}/stages
Negócios
- 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
Webhooks
- GETListar endpoints de webhook
/webhook-endpoints - POSTCriar endpoint de webhook
/webhook-endpoints - GETVer endpoint de webhook
/webhook-endpoints/{id} - PATCHEditar endpoint de webhook
/webhook-endpoints/{id} - DELETEExcluir endpoint de webhook
/webhook-endpoints/{id} - POSTTrocar a chave secreta do endpoint
/webhook-endpoints/{id}/rotate-secret - POSTEnviar um aviso de teste ao endpoint
/webhook-endpoints/{id}/test - GETListar as entregas de um endpoint
/webhook-endpoints/{id}/deliveries - POSTReenviar uma entrega
/webhook-endpoints/{id}/deliveries/{deliveryId}/retry