Copiar Página
Khal Docs
Raiz
CRM
CRM — Overview
Genérico (data)
CRM - Genérico
Listar/filtrar registros (qualquer tabela do CRM)
Criar/atualizar registros (qualquer tabela do CRM)
Hard-delete (não permitido para tabelas company)
Empresas Relacionadas
CRM - Empresas relacionadas
Listar relacionamentos de uma empresa (ambas as direções)
Tipos de relacionamento disponíveis
Criar relacionamento entre duas empresas
Alterar o tipo do relacionamento
Inativar relacionamento (reversível)
Excluir relacionamento (hard-delete)
Ticket ↔ Empresa
CRM - Ticket <-> Empresa
Empresas elegíveis para o ticket
Vincular / trocar a empresa do ticket
Templates
CRM - Templates
Listar templates do tenant (apenas IDs, sem fields)
Detalhe completo do template (com fields)
Pesquisa formatada por scope (CRMSearchResult)
Empresas do cliente
Listar tipos de relacionamento
Listar empresas de um cliente
Vincular empresa ao cliente
Trocar a empresa principal
Alterar tipo de relacionamento
Inativar vínculo
Reativar vínculo
Excluir vínculo
Workflow
Workflow - Overview
Tickets
Workflow - Tickets
Criar ticket com auto-vínculo / criação de customer via contato
Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
Criar ticket (básico, com integração CRM opcional)
Movimentar ticket entre fases (ou finalizar)
Atualizar dados do ticket (nome, descrição, valor)
Vincular cliente CRM a um ticket existente
Adicionar nota ou mensagem ao ticket
Atribuir ou transferir o responsável do ticket
Workspaces & Workflows
Workflow - Workspaces & Workflows
Listar workspaces e workflows acessíveis ao usuário
Listar fases de um workflow
Listar tickets de uma ou mais fases (paginado)
Webhooks
Eventos
📨 [Contrato] Evento entregue na sua URL
Catálogo de eventos disponíveis
Assinaturas
Listar webhooks cadastrados
Criar webhook (o secret aparece UMA única vez)
Testar conectividade de uma URL
Detalhar webhook
Atualizar webhook
Ativar/desativar webhook (toggle)
Remover webhook (soft delete)
Entregas
Log de entregas de uma assinatura
Reprocessar uma entrega
Reprocessar TODAS as entregas com falha
Integrações
Voz IA (ElevenLabs)
Criar ou atualizar a integração de Voz IA
Consultar a integração de Voz IA
Alterar a integração de Voz IA (secret, toggle, allowlist)
Remover a integração de Voz IA
Webhook pós-chamada (chamado pelo provedor de voz)
Configurações
Canais
WhatsApp oficial
Listar conexões de WhatsApp (a tela Canais › WhatsApp oficial)
Listar números disponíveis de uma WABA
Criar conexão de WhatsApp oficial
Conectar o número oficial (ativar a conexão)
Telefonia
Anexar gravação de ligação (telefonia de terceiros)
Registrar CSAT de ligação
Consultar status da gravação enviada
Templates
WhatsApp oficial
Listar templates HSM (a tela Templates › WhatsApp oficial)
Criar template HSM (+ Novo modelo)
Detalhar template
Atualizar template
Excluir template
Sincronizar templates com a Meta
Upload de mídia para o header do template
RCS
Listar templates de RCS
Base de dados
Modelo de colunas do CSV
Importar base (CSV) para uma tabela do CRM
Acompanhar as importações (validar o resultado)
Erros de uma importação
Exportar os erros em planilha
Raiz
Workflow
Tarefas
Criar tarefa
Listar tarefas
Resumo de tarefas
Consultar tarefa
Editar tarefa
Concluir tarefa
Cancelar (excluir) tarefa
Silenciar alarme
Tarefas do ticket
Esquemas
LoginRequest
FilterOperator
WebhookSubscription
ClienteEmpresaTipo
LoginResponse
FilterCondition
WebhookSubscriptionResumo
ClienteEmpresa
Error
Pagination
WebhookDelivery
ErroRegra
FilterRequest
WebhookEventEnvelope
FilterResponse
SetMethod
SetRequest
DeleteRequest
SuccessEnvelope
ErrorEnvelope
Empresa
EmpresaResumo
EmpresaRelacionadaCreate
EmpresaRelacionada
TicketInfoResponse
SuccessEnvelope
Copiar Página
{
"ok"
:
true
,
"data"
:
{
"property1"
:
"string"
,
"property2"
:
"string"
}
}