Inventário da API

Lista dos endpoints disponíveis com API Key.

Rotas não listadas aqui retornam 403 com código API_KEY_ROUTE_DENIED.

Base URL: https://v1.api.interflow.chat

Endpoints disponíveis

Chat

Método	Path	Doc
POST	/api/{organizationId}/chat/create	Criar chat — principal: cria o atendimento e pode enviar mensagem/template na mesma requisição
POST	/api/{organizationId}/chat/{chatId}/message	Enviar mensagem — chat já existente
POST	/api/{organizationId}/chat/{chatId}/message-sequence	Sequência
POST	/api/{organizationId}/chat/{chatId}/send-template	Template WhatsApp — chat já existente

Customers

Método	Path	Doc
POST	/api/{organizationId}/customers	Criar cliente
PUT	/api/{organizationId}/customers/{customerId}	Atualizar cliente
POST	/api/{organizationId}/customers/{customerId}/tags	Tags do cliente
DELETE	/api/{organizationId}/customers/{customerId}/tags/{tagId}	Tags do cliente
POST	/api/{organizationId}/customers/{customerId}/notes	Notas
PUT	/api/{organizationId}/customers/{customerId}/notes/{noteId}	Notas
DELETE	/api/{organizationId}/customers/{customerId}/notes/{noteId}	Notas
PUT	/api/{organizationId}/customers/{customerId}/stage	Estágio CRM
POST	/api/{organizationId}/customers/{customerId}/field-values	Campos personalizados

Tags

Método	Path	Doc
GET	/api/{organizationId}/tags	Tags
POST	/api/{organizationId}/tags	Tags
PUT	/api/{organizationId}/tags/{tagId}	Tags
DELETE	/api/{organizationId}/tags/{tagId}	Tags

Atalhos de mensagem

Não há endpoint para criar/editar atalhos. Para enviar várias mensagens em ordem, use sequência de mensagens. Veja também Atalhos e sequências.

Em breve

Endpoints previstos

• POST .../chat/{chatId}/resolve
• POST .../chat/{chatId}/reopen
• POST .../chat/{chatId}/transfer-to-team
• POST .../chat/{chatId}/transfer-to-agent
• POST .../chat/{chatId}/attend
• POST .../chat/{chatId}/start-flow

Webhooks de notificação (ainda não disponíveis)

Hoje a API cobre ações iniciadas pela integração (criar chat, enviar mensagem, etc.). Ainda não há webhooks para a Interflow avisar o seu sistema quando algo acontece no atendimento.

Pontos estratégicos planejados:

Evento	Por que importa
Mensagem recebida do cliente	Reagir em tempo real (CRM, bot externo, fila, ERP) sem polling
Chat criado / reaberto	Sincronizar novos atendimentos
Chat resolvido / arquivado	Fechar ciclo no sistema externo
Chat transferido (equipe / agente)	Atualizar responsável no seu lado
Status de entrega / leitura da mensagem	Confirmar envio e engajamento
Cliente atualizado (dados / estágio / tags)	Manter CRM externo alinhado

Prioridade inicial sugerida: mensagem recebida do cliente, por ser o evento mais usado em integrações bidirecionais.