Tudo o que o Formula IA faz, tela por tela.

Criar um novo agendamento. Obrigatórios: title (até 255 caracteres) e startAt. Datas (startAt e endAt) aceitas em: AAAA-MM-DD com ou sem hora (2025-01-15, 2025-01-15T14:30:00 ou 2025-01-15 14:30), com fuso opcional Z, ±HH:mm ou ±HHmm (2025-01-15T14:30:00-03:00, 2025-01-15T17:30:00.000Z), e DD/MM/AAAA com hora opcional HH:mm ou HH:mm:ss (15/01/2025 ou 15/01/2025 14:30). Com barra é sempre dia/mês/ano. Sem fuso, a hora vale no fuso horário do servidor (mande o fuso, ex.: -03:00, para não depender dele); só a data = 00:00. Número (timestamp) ou outro formato responde 400. endAt é opcional e não pode ser anterior a startAt. status: pending (padrão), confirmed, cancelled, completed ou no_show. contactId, whatsappId, userId (atendente responsável) e bookingProfessionalId (profissional da página de agendamento), quando enviados, precisam ser da empresa do token; sem userId o agendamento nasce sem atendente vinculado. Outros campos do corpo são ignorados (location, meetingLink e checkInStatus só pelo AppointmentUpdate). Erros: 400 ERR_MISSING_FIELDS (com fields), ERR_INVALID_APPOINTMENT_TITLE, ERR_INVALID_START_AT, ERR_INVALID_END_AT, ERR_END_AT_BEFORE_START_AT e ERR_INVALID_STATUS; 404 ERR_CONTACT_NOT_FOUND, ERR_CHANNEL_NOT_FOUND, ERR_USER_NOT_FOUND e ERR_BOOKING_PROFESSIONAL_NOT_FOUND.

Corpo (JSON)

{
  "title": "Reunião",
  "description": "Alinhamento de projeto",
  "contactId": 1,
  "contactName": "João Silva",
  "contactPhone": "5511999999999",
  "whatsappId": 1,
  "userId": 1,
  "bookingProfessionalId": 1,
  "startAt": "2025-01-15T14:30:00",
  "endAt": "2025-01-15T15:30:00",
  "status": "pending",
  "notes": "Detalhes do agendamento"
}

Listar agendamentos com filtros, em ordem de início (startAt). startFrom e startTo aceitam os mesmos formatos de data do AppointmentCreate (com barra é sempre DD/MM/AAAA; sem fuso vale o fuso horário do servidor). Só a data = 00:00 desse dia: para incluir o último dia inteiro, mande a hora em startTo (ex.: 31/01/2025 23:59:59). Data fora desses formatos responde 400 ERR_INVALID_FIELD com field (startFrom ou startTo).

Query params

Parâmetros de caminho

Atualizar um agendamento existente. Só os campos enviados mudam: title, description, startAt, endAt, status, checkInStatus, contactId, whatsappId, userId, bookingProfessionalId, contactName, contactPhone, notes, location e meetingLink (outros campos são ignorados). Para remarcar, use startAt (e endAt) nos mesmos formatos de data do AppointmentCreate (com barra é sempre DD/MM/AAAA); endAt null ou vazio apaga o término. userId (atendente responsável) e bookingProfessionalId (profissional da página de agendamento) precisam ser da sua empresa, como contactId e whatsappId; null ou vazio desvincula. checkInStatus: none, confirmed, on_the_way ou no_show (null ou vazio volta para none). Erros: 400 ERR_INVALID_APPOINTMENT_TITLE, ERR_INVALID_START_AT, ERR_INVALID_END_AT, ERR_END_AT_BEFORE_START_AT, ERR_INVALID_STATUS e ERR_INVALID_FIELD (com field, ex.: checkInStatus fora da lista); 404 ERR_APPOINTMENT_NOT_FOUND, ERR_CONTACT_NOT_FOUND, ERR_CHANNEL_NOT_FOUND, ERR_USER_NOT_FOUND e ERR_BOOKING_PROFESSIONAL_NOT_FOUND.

Parâmetros de caminho

Corpo (JSON)

{
  "startAt": "16/01/2025 10:00",
  "endAt": "16/01/2025 11:00",
  "title": "Reunião Atualizada",
  "status": "confirmed",
  "checkInStatus": "confirmed",
  "notes": "Novos detalhes"
}

Excluir um agendamento.

Parâmetros de caminho

Corpo (JSON)

{}

Criar um lembrete automático para agendamentos. O lembrete não tem data própria: ele dispara hoursBeforeEvent horas antes de cada agendamento. hoursBeforeEvent e messageType (message ou waba_template) são obrigatórios.

Corpo (JSON)

{
  "name": "Lembrete de consulta",
  "description": "Aviso enviado antes do agendamento",
  "hoursBeforeEvent": 24,
  "messageType": "message",
  "messageContent": "Lembrete: sua consulta é amanhã!",
  "whatsappId": 1,
  "active": true
}

Atualizar um lembrete agendado. Campos aceitos: name, description, hoursBeforeEvent, messageType, messageContent, whatsappId e active. Campo com outro nome é descartado sem erro.

Parâmetros de caminho

Corpo (JSON)

{
  "name": "Lembrete de consulta",
  "hoursBeforeEvent": 12,
  "messageType": "message",
  "messageContent": "Mensagem atualizada",
  "whatsappId": 1,
  "active": true
}

Excluir um lembrete agendado.

Parâmetros de caminho

Corpo (JSON)

{}

Alternar o estado de um lembrete: a cada chamada ele inverte entre ativo e inativo. Não recebe corpo e não é idempotente, então repetir a chamada volta ao estado anterior.

Parâmetros de caminho

Corpo (JSON)

{}

Criar uma nova campanha de disparo. Campos obrigatórios: name e sessionId (ou whatsappId). Informe message1/message2/message3 (ou message) — ou, para WABA, templateName + templateLanguage. start e delay têm default (agora e 20s). Esta rota não anexa mídia: a campanha nasce só com texto e o arquivo precisa ser anexado pelo painel.

Corpo (JSON)

{
  "name": "Campanha Promo",
  "sessionId": 1,
  "message1": "Olá {{name}}!",
  "message2": "Olá {{name}}, tudo bem?",
  "message3": "Oi {{name}}!",
  "start": "2026-05-01 10:00",
  "delay": 20,
  "sendTimeWindowEnabled": false,
  "sendTimeStart": null,
  "sendTimeEnd": null
}

Listar campanhas com paginação. Esta rota não filtra por status.

Query params

Atualizar dados de uma campanha. Só é aceito enquanto a campanha estiver em pending, scheduled, paused ou canceled; em processing ou finished a rota responde 404. O texto vai em message1/message2/message3 e a variável é {{name}}. O status não é editável aqui: use start, cancel, pause ou resume.

Parâmetros de caminho

Corpo (JSON)

{
  "name": "Campanha Atualizada",
  "message1": "Nova mensagem {{name}}!"
}

Duplicar uma campanha existente.

Parâmetros de caminho

Corpo (JSON)

{}

Iniciar o disparo de uma campanha.

Parâmetros de caminho

Corpo (JSON)

{}

Cancelar uma campanha em andamento.

Parâmetros de caminho

Corpo (JSON)

{}

Pausar uma campanha em andamento.

Parâmetros de caminho

Corpo (JSON)

{}

Retomar uma campanha pausada.

Parâmetros de caminho

Corpo (JSON)

{}

Pular para o próximo contato da campanha.

Parâmetros de caminho

Corpo (JSON)

{}

Parâmetros de caminho

Excluir uma campanha.

Parâmetros de caminho

Corpo (JSON)

{}

Parâmetros de caminho

Adicionar contatos a uma campanha. Aceita 3 formatos: (1) array de IDs [{ id }], (2) array com number/name (cria ou reusa o contato), (3) objeto { contactsIds: [1,2,3] }.

Parâmetros de caminho

Corpo (JSON)

[
  {
    "name": "Contato 1",
    "number": "5511999990001"
  },
  {
    "id": 42
  }
]

Remover um contato de uma campanha.

Parâmetros de caminho

Corpo (JSON)

{}

Remover todos os contatos de uma campanha.

Parâmetros de caminho

Corpo (JSON)

{}

Buscar informações de um canal pelo número.

Corpo (JSON)

{
  "number": "5511999999999"
}

Buscar informações de um canal pelo ID.

Corpo (JSON)

{
  "id": 43
}

Listar grupos e participantes da sessão WhatsApp.

Corpo (JSON)

{
  "listGroups": true,
  "listParticipants": true
}

Criar uma nova sessão/instância WhatsApp.

Corpo (JSON)

{
  "name": "Minha Instância",
  "status": "DISCONNECTED",
  "type": "baileys"
}

Excluir uma sessão WhatsApp.

Corpo (JSON)

{
  "whatsappId": 1
}

Iniciar/conectar uma sessão WhatsApp.

Corpo (JSON)

{
  "whatsappId": 1
}

Obter o QR Code de uma sessão para conexão.

Corpo (JSON)

{
  "whatsappId": 1
}

Solicitar novo QR Code para uma sessão.

Corpo (JSON)

{
  "whatsappId": 1
}

Criar um novo contato no sistema. Endereço opcional: cep (até 20 caracteres), logradouro (rua), numeroEndereco, complemento, bairro e cidade (até 255 cada) e estado (até 100). Os textos são aparados e o que passar do limite é cortado, sem erro; o estado é gravado como veio. A resposta traz o contato com os 7 campos de endereço (cep, logradouro, numeroEndereco, complemento, bairro, cidade, estado).

Corpo (JSON)

{
  "name": "Nome Completo",
  "number": "5511999999999",
  "email": "contato@email.com",
  "cpf": "000.000.000-00",
  "firstName": "Nome",
  "lastName": "Sobrenome",
  "businessName": "Empresa",
  "birthdayDate": "01/01/1990",
  "cep": "01310-100",
  "logradouro": "Avenida Paulista",
  "numeroEndereco": "1000",
  "complemento": "Sala 101",
  "bairro": "Bela Vista",
  "cidade": "São Paulo",
  "estado": "SP"
}

Buscar dados de um contato pelo número do WhatsApp. A resposta traz o endereço do contato: cep, logradouro, numeroEndereco, complemento, bairro, cidade e estado.

Corpo (JSON)

{
  "number": "5511999999999"
}

Atualizar dados de um contato existente. Endereço: cep (até 20 caracteres), logradouro (rua), numeroEndereco, complemento, bairro e cidade (até 255 cada) e estado (até 100), aparados e cortados no limite, sem erro; o estado é gravado como veio. Em cada campo de endereço, "" ou null apaga o valor e campo ausente fica como está. A resposta traz o contato com os 7 campos de endereço.

Corpo (JSON)

{
  "name": "Nome Atualizado",
  "number": "5511999999999",
  "email": "novo@email.com",
  "cpf": "000.000.000-00",
  "firstName": "Nome",
  "lastName": "Sobrenome",
  "businessName": "Empresa",
  "birthdayDate": "01/01/1990",
  "kanban": 2,
  "cep": "01310-100",
  "logradouro": "Avenida Paulista",
  "numeroEndereco": "1000",
  "complemento": "Sala 101",
  "bairro": "Bela Vista",
  "cidade": "São Paulo",
  "estado": "SP"
}

Gerar o link de convite do Telegram de um contato já cadastrado: quando a pessoa abre o link e toca em Iniciar, a conta do Telegram dela é ligada a esse contato e o atendimento pelo Telegram fica disponível para ele. O link vale 7 dias, é de uso único e só o mais recente de cada contato funciona (gerar de novo invalida o anterior); quem tiver o link consegue usá-lo. Informe contactId ou, no lugar dele, number (número de telefone do contato; número que corresponde a mais de um contato devolve 422 ERR_NUMBER_AMBIGUOUS com a lista candidates). whatsappId é o bot do Telegram: opcional quando o token é de uma sessão do Telegram (vale o bot do token; outro whatsappId responde 403 ERR_SESSION_NOT_AUTH_TOKEN) ou quando a empresa tem um só bot conectado. Resposta (em data): { link, expiresAt, contactId, whatsappId }. Erros: 400 ERR_CONTACT_OR_NUMBER_REQUIRED (sem contactId e sem number), 404 ERR_CONTACT_NOT_FOUND (contato inexistente ou mesclado), 409 ERR_TELEGRAM_ALREADY_LINKED (o contato já tem Telegram), 400 ERR_TELEGRAM_INVITE_GROUP (grupo), 409 ERR_TELEGRAM_BOT_NOT_FOUND (nenhum bot do Telegram conectado, ou whatsappId que não é um bot do Telegram da empresa), 400 ERR_TELEGRAM_BOT_REQUIRED (mais de um bot conectado: informe whatsappId), 409 ERR_TELEGRAM_BOT_OFFLINE (bot desconectado), 424 ERR_TELEGRAM_BOT_UNAVAILABLE (o Telegram não respondeu ao consultar o bot), 409 ERR_TELEGRAM_INVITE_DISABLED (recurso desligado no servidor), 409 ERR_TELEGRAM_INVITE_UNAVAILABLE (servidor ainda sem a atualização do banco).

Corpo (JSON)

{
  "contactId": 123,
  "whatsappId": 7
}

Bloquear ou desbloquear um contato.

Corpo (JSON)

{
  "contactId": 1,
  "blocked": true
}

Buscar contatos com filtros avançados (texto, tag, wallet, bloqueado e endereço). addressBairro e addressCidade buscam por "contém", sem diferenciar acento e maiúsculas. addressUfs aceita as siglas das 27 UFs em texto separado por vírgula ("SP,RJ") ou em lista (["SP", "RJ"]) e acha também o estado gravado por extenso (ex.: "São Paulo"); UF pedida sem nenhuma sigla válida devolve lista vazia. Resposta: { success, data, pagination: { page, limit, total, totalPages, hasMore }, meta: { addressFilter } }; cada contato de data traz id, number, name, email, blocked, cep, logradouro, numeroEndereco, complemento, bairro, cidade, estado, tags e wallets. meta.addressFilter false indica servidor sem as colunas de endereço: os filtros de endereço foram ignorados.

Corpo (JSON)

{
  "searchParam": "",
  "page": 1,
  "limit": 40,
  "tagId": null,
  "walletId": null,
  "blocked": false,
  "addressBairro": "Bela Vista",
  "addressCidade": "São Paulo",
  "addressUfs": "SP,RJ"
}

Atualizar o kanban (carteira) de um contato.

Corpo (JSON)

{
  "contactId": 1,
  "kanban": 2
}

Definir as wallets (carteiras) de um contato. A lista enviada substitui a atual: para tirar uma wallet, reenvie apenas as que devem permanecer; walletIds: [] (ou walletId: null) descarteiriza o contato.

Corpo (JSON)

{
  "contactId": 1,
  "walletId": 2
}

Buscar campos personalizados (extraInfo) de um contato.

Query params

Atualizar campos personalizados de um contato.

Corpo (JSON)

{
  "contactId": 1,
  "extraInfo": [
    {
      "name": "Campo 1",
      "value": "Valor 1"
    },
    {
      "name": "Campo 2",
      "value": "Valor 2"
    }
  ]
}

Listar pares de contatos duplicados (variantes do 9º dígito BR / colisões) candidatos a mesclagem. Sem paginação: use limit para ampliar o lote. O limit é aplicado antes do filtro matchKinds.

Corpo (JSON)

{
  "limit": 500,
  "matchKinds": [
    "nine_digit_variant",
    "cross_collision"
  ]
}

Mesclar contatos duplicados em lote. Cada par indica o contato principal e o duplicado, por id (primaryId/duplicateId) ou por número (primaryNumber/duplicateNumber).

Corpo (JSON)

{
  "pairs": [
    {
      "primaryId": 1,
      "duplicateId": 2
    },
    {
      "primaryNumber": "5511999999999",
      "duplicateNumber": "551199999999"
    }
  ]
}

Desfazer a mesclagem de contatos previamente mesclados. Informe duplicateIds (ids dos contatos duplicados) ou mergeLogIds (ids dos registros de mesclagem). Um dos dois é obrigatório.

Corpo (JSON)

{
  "duplicateIds": [
    2
  ]
}

Criar um novo pipeline de CRM. O pipeline só tem nome: não existe campo de descrição.

Corpo (JSON)

{
  "name": "Pipeline de Vendas"
}

Listar os pipelines do tenant, com paginação.

Query params

Parâmetros de caminho

Atualizar um pipeline existente. O pipeline só tem nome: não existe campo de descrição.

Parâmetros de caminho

Corpo (JSON)

{
  "name": "Pipeline Atualizado"
}

Excluir um pipeline. Só é aceito quando o pipeline não tem nenhuma etapa, oportunidade ou ação vinculada; caso contrário a rota responde 500. Apague as etapas e oportunidades antes.

Parâmetros de caminho

Corpo (JSON)

{}

Criar uma etapa (stage) em um pipeline.

Corpo (JSON)

{
  "name": "Prospecção",
  "pipelineId": 1,
  "order": 1,
  "color": "#4A90E2"
}

Listar etapas de um pipeline.

Query params

Parâmetros de caminho

Atualizar uma etapa existente.

Parâmetros de caminho

Corpo (JSON)

{
  "name": "Negociação",
  "order": 2,
  "color": "#E24A4A"
}

Excluir uma etapa de pipeline. Só é aceito quando a etapa não tem oportunidade nem ação apontando para ela; caso contrário a rota responde 500. Mova as oportunidades antes.

Parâmetros de caminho

Corpo (JSON)

{}

Estatísticas gerais do período: quantidade de atendimentos, demanda ativa e receptiva, tempos médios e novos contatos. Por padrão considera apenas atendimentos individuais.

Query params

Tickets agrupados por canal de comunicação.

Query params

Evolução diária/mensal do volume de tickets.

Query params

Evolução de tickets por valor (CRM).

Query params

Evolução de tickets por nome de canal.

Query params

Tickets atribuídos por usuário/atendente.

Query params

Resumo de tickets por usuário com métricas.

Query params

Tickets agrupados por fila de atendimento.

Query params

Tickets agrupados por status (aberto, pendente, encerrado).

Query params

Tickets agrupados por motivo de encerramento.

Query params

Disparo rápido para lista de números sem criar tickets. Só funciona em canais whatsapp, baileys e zapo, e whatsappType é obrigatório.

Corpo (form-data)

Disparo em lote criando tickets para cada contato. whatsappType é obrigatório.

Corpo (form-data)

Disparo com registro de lote, um destinatário por chamada. A substituição das variáveis é feita pelo integrador: o texto enviado em message sai literalmente como está.

Corpo (form-data)

Disparo individual de mensagem a um único número. whatsappType é obrigatório.

Corpo (form-data)

Listar registros de disparos em lote. Disparos de SMS em massa (dispatchType "sms") não têm canal (whatsapp null) e vêm sem a lista de números (metadata.contacts); o detalhe traz a lista.

Query params

Parâmetros de caminho

Atualizar status de um disparo em lote. Disparos de SMS em massa (dispatchType "sms") são controlados pelo servidor e respondem 400 ERR_SMS_BULK_READONLY por aqui.

Parâmetros de caminho

Corpo (JSON)

{
  "status": "cancelled",
  "cancellationReason": "Motivo do cancelamento"
}

Incrementar o progresso de um disparo em lote. Disparos de SMS em massa (dispatchType "sms") são controlados pelo servidor e respondem 400 ERR_SMS_BULK_READONLY.

Parâmetros de caminho

Corpo (JSON)

{
  "success": true,
  "error": null
}

Enviar texto livre usando o ticketId como identificador da conversa — em QUALQUER canal do tenant (WhatsApp, Instagram, Messenger, Telegram, Webchat, E-mail, Hub, Mercado Livre...). O canal é resolvido pelo próprio ticket; o token vale para qualquer ticket do tenant. Ticket fechado exige reopen: true (senão 409 ERR_TICKET_CLOSED). Resposta inclui ticketId efetivo, messageId e delivered (webchat).

Corpo (JSON)

{
  "ticketId": 1262,
  "body": "Olá! Como posso ajudar?",
  "externalKey": "chave-001",
  "reopen": false,
  "isClosed": false
}

Enviar arquivo por ticketId via multipart/form-data (imagem, vídeo, áudio, documento — conforme o canal suportar).

Corpo (form-data)

Enviar mídia por ticketId a partir de URL pública (o backend baixa a URL; esquema http/https, sem redirect, hosts internos bloqueados).

Corpo (JSON)

{
  "ticketId": 1262,
  "mediaUrl": "https://exemplo.com/imagem.png",
  "body": "Legenda opcional",
  "externalKey": "chave-001"
}

Enviar arquivo em Base64 por ticketId (mimeType obrigatório; fileName opcional, sem caminhos).

Corpo (JSON)

{
  "ticketId": 1262,
  "body": "Legenda opcional",
  "base64Data": "iVBORw0KGgoAAAANSUhEUgAAAAUA...",
  "mimeType": "image/png",
  "fileName": "exemplo",
  "externalKey": "chave-001"
}

Criar uma nova fila de atendimento. O nome da fila vai no campo queue, único obrigatório. Cor e responsável não são definidos por esta rota: a fila nasce sem cor e vinculada ao usuário dono do token.

Corpo (JSON)

{
  "queue": "Fila Suporte",
  "isActive": true,
  "businessHours": [],
  "messageBusinessHours": "Estamos fora do horário de atendimento."
}

Atualizar uma fila de atendimento existente. O nome da fila vai no campo queue. Atenção: esta rota zera a cor da fila e refaz o vínculo com o usuário dono do token; para preservar a cor, edite pelo painel.

Parâmetros de caminho

Corpo (JSON)

{
  "queue": "Fila Suporte Atualizada",
  "isActive": true,
  "businessHours": [],
  "messageBusinessHours": "Estamos fora do horário de atendimento."
}

Excluir uma fila de atendimento pelo ID.

Parâmetros de caminho

Corpo (JSON)

{}

Listar arquivos da galeria do tenant, com paginação fixa de 20 itens por página.

Query params

Fazer upload de arquivo(s) para a galeria (máx. 10 arquivos, 500MB).

Corpo (form-data)

Excluir um arquivo da galeria pelo ID.

Parâmetros de caminho

Corpo (JSON)

{}

Listar grupos do WhatsApp da sessão.

Corpo (JSON)

{
  "whatsappId": 1
}

Buscar informações de um grupo pelo ID.

Corpo (JSON)

{
  "whatsappId": 1,
  "groupId": "12345678901@g.us"
}

Criar um ou mais grupos no WhatsApp. titles aceita texto ou lista e cria um grupo por título; number é o participante inicial (um só). A resposta traz apenas o status por título, sem o ID do grupo: para obter o ID, chame /group/list logo depois e localize o grupo pelo nome.

Corpo (JSON)

{
  "whatsappId": 1,
  "titles": [
    "Grupo de Suporte"
  ],
  "number": "5511999999999"
}

Listar participantes de um ou mais grupos.

Corpo (JSON)

{
  "whatsappId": 1,
  "groupIds": [
    "12345678901@g.us"
  ]
}

Adicionar participante(s) a um ou mais grupos. Em geral exige que o número conectado seja administrador (a não ser que o grupo permita que qualquer membro adicione). A resposta traz um item por grupo: { groupId, status, message?, reason?, providerStatus?, participants? }. Nos canais por QR Code (Baileys e Zapo), participants traz cada número: { participant, jid, status (success, error ou unknown), code, reason }; reason do número: invite_required (a pessoa só entra por convite), already_in_group, not_allowed, not_on_whatsapp ou rejected. Se todos os números forem recusados, o grupo vem com status error, message ERR_GROUP_PARTICIPANTS_REJECTED e reason participants_rejected. Nas demais falhas, reason do grupo: session_not_connected, not_admin, group_not_found, timeout, invalid_request (por exemplo participants vazio, com message ERR_GROUP_PARTICIPANTS_REQUIRED), provider_error (com providerStatus, o status HTTP do provedor) ou unknown.

Corpo (JSON)

{
  "whatsappId": 1,
  "groupIds": [
    "12345678901@g.us"
  ],
  "participants": [
    "5511777777777"
  ]
}

Remover participante(s) de um ou mais grupos. Requer que o número conectado seja administrador do grupo. A resposta traz um item por grupo: { groupId, status, message?, reason?, providerStatus?, participants? }. Nos canais por QR Code (Baileys e Zapo), participants traz cada número: { participant, jid, status (success, error ou unknown), code, reason }; reason do número: not_in_group (o número não está no grupo) ou rejected. Se todos os números forem recusados, o grupo vem com status error, message ERR_GROUP_PARTICIPANTS_REJECTED e reason participants_rejected. Nas demais falhas, reason do grupo: session_not_connected, not_admin, group_not_found, timeout, invalid_request (por exemplo participants vazio, com message ERR_GROUP_PARTICIPANTS_REQUIRED), provider_error (com providerStatus, o status HTTP do provedor) ou unknown.

Corpo (JSON)

{
  "whatsappId": 1,
  "groupIds": [
    "12345678901@g.us"
  ],
  "participants": [
    "5511777777777"
  ]
}

Promover participante(s) a administrador do grupo. Requer que o número conectado seja administrador do grupo. A resposta traz um item por grupo: { groupId, status, message?, reason?, providerStatus?, participants? }. Nos canais por QR Code (Baileys e Zapo), participants traz cada número: { participant, jid, status (success, error ou unknown), code, reason }; reason do número: not_in_group (o número não está no grupo) ou rejected. Se todos os números forem recusados, o grupo vem com status error, message ERR_GROUP_PARTICIPANTS_REJECTED e reason participants_rejected. Nas demais falhas, reason do grupo: session_not_connected, not_admin, group_not_found, timeout, invalid_request (por exemplo participants vazio, com message ERR_GROUP_PARTICIPANTS_REQUIRED), provider_error (com providerStatus, o status HTTP do provedor) ou unknown.

Corpo (JSON)

{
  "whatsappId": 1,
  "groupIds": [
    "12345678901@g.us"
  ],
  "participants": [
    "5511777777777"
  ]
}

Rebaixar administrador(es) a participante comum. Requer que o número conectado seja administrador do grupo. A resposta traz um item por grupo: { groupId, status, message?, reason?, providerStatus?, participants? }. Nos canais por QR Code (Baileys e Zapo), participants traz cada número: { participant, jid, status (success, error ou unknown), code, reason }; reason do número: not_in_group (o número não está no grupo) ou rejected. Se todos os números forem recusados, o grupo vem com status error, message ERR_GROUP_PARTICIPANTS_REJECTED e reason participants_rejected. Nas demais falhas, reason do grupo: session_not_connected, not_admin, group_not_found, timeout, invalid_request (por exemplo participants vazio, com message ERR_GROUP_PARTICIPANTS_REQUIRED), provider_error (com providerStatus, o status HTTP do provedor) ou unknown.

Corpo (JSON)

{
  "whatsappId": 1,
  "groupIds": [
    "12345678901@g.us"
  ],
  "participants": [
    "5511777777777"
  ]
}

Alterar o nome/título de um grupo.

Corpo (JSON)

{
  "whatsappId": 1,
  "groupIds": [
    "12345678901@g.us"
  ],
  "title": "Novo Nome do Grupo"
}

Alterar a descrição de um grupo.

Corpo (JSON)

{
  "whatsappId": 1,
  "groupIds": [
    "12345678901@g.us"
  ],
  "description": "Nova descrição do grupo"
}

Configurar se apenas admins podem enviar mensagens.

Corpo (JSON)

{
  "whatsappId": 1,
  "groupIds": [
    "12345678901@g.us"
  ],
  "adminsOnly": true
}

Obter o link de convite de um grupo. Requer que o número conectado seja administrador do grupo. Disponível nos canais por QR Code (Baileys e Zapo); em outros canais responde com inviteCode nulo. Resposta: { groupId, inviteCode, inviteLink } e, quando não houver código, um campo adicional reason (not_admin, group_not_found, timeout, channel_not_supported ou unknown).

Corpo (JSON)

{
  "whatsappId": 1,
  "groupId": "12345678901@g.us"
}

Revogar o link de convite atual do grupo e gerar um novo. Requer que o número conectado seja administrador. O link anterior deixa de funcionar imediatamente. Disponível nos canais por QR Code (Baileys e Zapo).

Corpo (JSON)

{
  "whatsappId": 1,
  "groupId": "12345678901@g.us"
}

Alterar a foto de perfil de um grupo (multipart/form-data).

Corpo (form-data)

Sair de um grupo (somente canal WABA oficial — outros tipos retornam ERR_LEAVE_GROUP_WABA_ONLY).

Corpo (JSON)

{
  "whatsappId": 1,
  "groupId": "12345678901@g.us"
}

Enviar Quick Reply via Instagram DM. Suporta texto e tipo user_phone_number.

Corpo (JSON)

{
  "ticketId": 1262,
  "message": "Escolha uma opção:",
  "quickReplies": [
    {
      "content_type": "text",
      "title": "Sim",
      "payload": "YES"
    },
    {
      "content_type": "text",
      "title": "Não",
      "payload": "NO"
    },
    {
      "content_type": "user_phone_number"
    }
  ]
}

Enviar Button Template via Instagram DM (até 3 botões postback/web_url).

Corpo (JSON)

{
  "ticketId": 1262,
  "message": "Selecione uma ação:",
  "buttons": [
    {
      "type": "postback",
      "title": "Comprar",
      "payload": "BUY"
    },
    {
      "type": "web_url",
      "title": "Visitar site",
      "url": "https://exemplo.com"
    }
  ]
}

Enviar Generic Template (carrossel de cards com imagem, título e botões) via Instagram DM.

Corpo (JSON)

{
  "ticketId": 1262,
  "elements": [
    {
      "title": "Produto 1",
      "subtitle": "Descrição",
      "image_url": "https://exemplo.com/img.jpg",
      "buttons": [
        {
          "type": "postback",
          "title": "Ver",
          "payload": "PROD_1"
        }
      ]
    }
  ]
}

Gerenciar Ice Breakers do Instagram (perguntas iniciais). action: get | set | delete.

Corpo (JSON)

{
  "action": "set",
  "iceBreakers": [
    {
      "question": "Qual o horário?",
      "payload": "HOURS"
    },
    {
      "question": "Vocês fazem entrega?",
      "payload": "DELIVERY"
    }
  ]
}

Gerenciar Persistent Menu do Instagram. action: get | set | delete.

Corpo (JSON)

{
  "action": "set",
  "composerInputDisabled": false,
  "menuItems": [
    {
      "type": "postback",
      "title": "Menu",
      "payload": "MAIN_MENU"
    },
    {
      "type": "web_url",
      "title": "Site",
      "url": "https://exemplo.com"
    }
  ]
}

Enviar Quick Reply via Messenger. Suporta texto e tipo user_phone_number.

Corpo (JSON)

{
  "ticketId": 1262,
  "message": "Escolha uma opção:",
  "quickReplies": [
    {
      "content_type": "text",
      "title": "Sim",
      "payload": "YES"
    },
    {
      "content_type": "text",
      "title": "Não",
      "payload": "NO"
    }
  ]
}

Enviar Button Template via Messenger (até 3 botões postback/web_url).

Corpo (JSON)

{
  "ticketId": 1262,
  "message": "Selecione:",
  "buttons": [
    {
      "type": "postback",
      "title": "Opção 1",
      "payload": "OPT_1"
    },
    {
      "type": "web_url",
      "title": "Visitar",
      "url": "https://exemplo.com"
    }
  ]
}

Enviar Generic Template (carrossel de cards) via Messenger.

Corpo (JSON)

{
  "ticketId": 1262,
  "elements": [
    {
      "title": "Card 1",
      "subtitle": "Subtítulo",
      "image_url": "https://exemplo.com/img.jpg",
      "buttons": [
        {
          "type": "postback",
          "title": "Ação",
          "payload": "ACT"
        }
      ]
    }
  ]
}

Enviar Media Template (imagem/vídeo) com botões via Messenger. URL externa é convertida em attachment_id automaticamente.

Corpo (JSON)

{
  "ticketId": 1262,
  "mediaType": "image",
  "mediaUrl": "https://exemplo.com/imagem.jpg",
  "buttons": [
    {
      "type": "postback",
      "title": "Comprar",
      "payload": "BUY"
    }
  ]
}

Enviar Receipt Template (recibo de compra) via Messenger.

Corpo (JSON)

{
  "ticketId": 1262,
  "receipt": {
    "recipient_name": "João Silva",
    "order_number": "ORD-001",
    "currency": "BRL",
    "payment_method": "PIX",
    "summary": {
      "total_cost": 150
    },
    "elements": [
      {
        "title": "Produto A",
        "price": 100,
        "quantity": 1
      },
      {
        "title": "Produto B",
        "price": 50,
        "quantity": 1
      }
    ]
  }
}

Enviar mensagem fora da janela de 24h com Message Tag (ex: POST_PURCHASE_UPDATE, ACCOUNT_UPDATE, CONFIRMED_EVENT_UPDATE, HUMAN_AGENT).

Corpo (JSON)

{
  "ticketId": 1262,
  "message": "Seu pedido foi aprovado.",
  "tag": "POST_PURCHASE_UPDATE"
}

Enviar Customer Feedback Template (CSAT/NPS/CES) via Messenger. Requer business_privacy_url.

Corpo (JSON)

{
  "ticketId": 1262,
  "title": "Avalie sua experiência",
  "subtitle": "Opcional",
  "business_privacy_url": "https://exemplo.com/privacidade",
  "expires_in_days": 7,
  "feedback_screens": [
    {
      "questions": [
        {
          "id": "CSAT",
          "type": "csat",
          "title": "Como foi nosso atendimento?"
        }
      ]
    }
  ]
}

Gerenciar Greeting Text da página do Messenger. action: get | set | delete.

Corpo (JSON)

{
  "action": "set",
  "greetings": [
    {
      "locale": "default",
      "text": "Olá! Como podemos ajudar?"
    }
  ]
}

Gerenciar Personas da página do Messenger. action: list | create | delete. Para create, informe name e profilePictureUrl; para delete, informe personaId (o id vem do retorno de list).

Corpo (JSON)

{
  "action": "create",
  "name": "Atendente Ana",
  "profilePictureUrl": "https://exemplo.com/ana.jpg"
}

Enviar botões de resposta rápida (Quick Reply) via Baileys. Exige canal do tipo baileys.

Corpo (JSON)

{
  "ticketId": 1262,
  "body": {
    "text": "Escolha uma opção:"
  },
  "footer": {
    "text": "Rodapé opcional"
  },
  "buttons": [
    {
      "display_text": "Opção 1",
      "id": "op1"
    },
    {
      "display_text": "Opção 2",
      "id": "op2"
    }
  ]
}

Enviar lista de seleção única com seções e itens via Baileys.

Corpo (JSON)

{
  "ticketId": 1262,
  "body": {
    "text": "Escolha uma opção:"
  },
  "footer": {
    "text": "Rodapé opcional"
  },
  "list": {
    "title": "Ver opções",
    "sections": [
      {
        "title": "Seção 1",
        "rows": [
          {
            "id": "1",
            "title": "Item 1",
            "description": "Descrição"
          },
          {
            "id": "2",
            "title": "Item 2"
          }
        ]
      }
    ]
  }
}

Enviar botão PIX com chave copia-e-cola via Baileys.

Corpo (JSON)

{
  "ticketId": 1262,
  "pixType": "EVP",
  "pixKey": "chave-aleatoria-uuid",
  "pixName": "Nome Beneficiário",
  "bodyText": "Pague com PIX:"
}

Enviar botão CTA de copiar código (ex: cupom, código de rastreio) via Baileys.

Corpo (JSON)

{
  "ticketId": 1262,
  "body": {
    "text": "Copie seu código de rastreio:"
  },
  "footer": {
    "text": "Válido por 24h"
  },
  "displayText": "Copiar código",
  "copyCode": "BR123456789"
}

Enviar botão CTA de abrir URL via Baileys.

Corpo (JSON)

{
  "ticketId": 1262,
  "body": {
    "text": "Acesse nosso site:"
  },
  "footer": {
    "text": "Clique para visitar"
  },
  "displayText": "Visitar site",
  "url": "https://exemplo.com"
}

Enviar botão CTA de ligar (link tel:) via Baileys.

Corpo (JSON)

{
  "ticketId": 1262,
  "body": {
    "text": "Precisa de ajuda?"
  },
  "footer": {
    "text": "Ligue para nós"
  },
  "displayText": "Ligar agora",
  "phoneNumber": "+5511999999999"
}

Enviar botões de resposta rápida via UazAPI (até 3 opções). Exige canal do tipo uazapi.

Corpo (JSON)

{
  "ticketId": 1262,
  "text": "Escolha uma opção:",
  "choices": [
    "Opção 1",
    "Opção 2",
    "Opção 3"
  ],
  "footerText": "Rodapé opcional",
  "imageButton": "https://exemplo.com/img.png"
}

Enviar lista de opções com botão de abertura via UazAPI. Exige canal do tipo uazapi.

Corpo (JSON)

{
  "ticketId": 1262,
  "text": "Escolha uma opção:",
  "choices": [
    "Item 1",
    "Item 2",
    "Item 3",
    "Item 4"
  ],
  "listButton": "Ver opções",
  "footerText": "Selecione uma opção"
}

Enviar enquete com múltiplas opções via UazAPI. Exige canal do tipo uazapi.

Corpo (JSON)

{
  "ticketId": 1262,
  "text": "Qual sua preferência?",
  "choices": [
    "Opção A",
    "Opção B",
    "Opção C"
  ],
  "selectableCount": 1
}

Enviar carrossel de cards com botões via UazAPI.

Corpo (JSON)

{
  "ticketId": 1262,
  "text": "Confira nossas opções:",
  "carousel": [
    {
      "text": "Produto A",
      "image": "https://exemplo.com/a.png",
      "buttons": [
        {
          "text": "Ver detalhes",
          "type": "REPLY"
        }
      ]
    },
    {
      "text": "Produto B",
      "image": "https://exemplo.com/b.png",
      "buttons": [
        {
          "text": "Comprar",
          "type": "URL"
        }
      ]
    }
  ]
}

Enviar botão PIX nativo via UazAPI.

Corpo (JSON)

{
  "ticketId": 1262,
  "pixType": "EVP",
  "pixKey": "chave-aleatoria-uuid",
  "pixName": "Nome Beneficiário"
}

Enviar botão de compartilhar localização via UazAPI.

Corpo (JSON)

{
  "ticketId": 1262,
  "text": "Por favor, compartilhe sua localização:"
}

Enviar cobrança interativa via UazAPI. Obrigatórios: ticketId e amount. Opcionais: PIX (pixType, pixKey, pixName), boleto (boletoCode), link de pagamento (paymentLink) e anexo (fileUrl, fileName).

Corpo (JSON)

{
  "ticketId": 1262,
  "amount": 150,
  "title": "Pedido #001",
  "text": "Sua cobrança está pronta:",
  "footer": "Vencimento em 3 dias",
  "itemName": "Produto X",
  "invoiceNumber": "NF-001",
  "pixType": "EVP",
  "pixKey": "chave-aleatoria-uuid",
  "pixName": "Nome Beneficiário",
  "paymentLink": "https://pagamento.exemplo.com/001",
  "boletoCode": "34191790010104351004791020150008291070026000",
  "fileUrl": "https://exemplo.com/boleto.pdf",
  "fileName": "boleto.pdf"
}

Enviar mensagem com botões interativos (até 3) via WABA. Exige canal do tipo WhatsApp Business API (waba): canais Dialog360 e Gupshup respondem 400 ERR_CHANNEL_WABA_REQUIRED.

Corpo (JSON)

{
  "number": "5511999999999",
  "message": "Escolha uma opção:",
  "button1": "Opção 1",
  "button2": "Opção 2",
  "button3": "Opção 3",
  "ticketId": 1262
}

Enviar lista interativa com seções e itens selecionáveis via WABA. Exige canal do tipo WhatsApp Business API (waba): canais Dialog360 e Gupshup respondem 400 ERR_CHANNEL_WABA_REQUIRED. Recusa da Meta (número inválido, fora da janela de 24 h, lista fora do formato) responde 400 { success: false, error: "ERR_WABA_SEND_FAILED", metaStatus, metaCode, metaSubcode, message } com o código e a mensagem da Meta.

Corpo (JSON)

{
  "number": "5511999999999",
  "header": "Menu Principal",
  "body": "Escolha uma opção:",
  "footer": "Selecione uma opção",
  "button_text": "Ver opções",
  "sections": [
    {
      "title": "Seção 1",
      "rows": [
        {
          "id": "1",
          "title": "Opção 1",
          "description": "Desc 1"
        },
        {
          "id": "2",
          "title": "Opção 2",
          "description": "Desc 2"
        }
      ]
    }
  ],
  "ticketId": 1262
}

Enviar botões de resposta rápida (Quick Reply) via Zapo (até 3 botões). Exige canal do tipo zapo.

Corpo (JSON)

{
  "ticketId": 1262,
  "body": {
    "text": "Escolha uma opção:"
  },
  "footer": {
    "text": "Rodapé opcional"
  },
  "buttons": [
    {
      "display_text": "Opção 1",
      "id": "op1"
    },
    {
      "display_text": "Opção 2",
      "id": "op2"
    }
  ]
}

Enviar lista de seleção única com seções e itens via Zapo.

Corpo (JSON)

{
  "ticketId": 1262,
  "body": {
    "text": "Escolha uma opção:"
  },
  "footer": {
    "text": "Rodapé opcional"
  },
  "list": {
    "title": "Ver opções",
    "sections": [
      {
        "title": "Seção 1",
        "rows": [
          {
            "id": "1",
            "title": "Item 1",
            "description": "Descrição"
          },
          {
            "id": "2",
            "title": "Item 2"
          }
        ]
      }
    ]
  }
}

Enviar botão PIX com chave copia-e-cola via Zapo.

Corpo (JSON)

{
  "ticketId": 1262,
  "pixType": "EVP",
  "pixKey": "chave-aleatoria-uuid",
  "pixName": "Nome Beneficiário",
  "bodyText": "Pague com PIX:"
}

Enviar botão CTA de copiar código (ex: cupom, código de rastreio) via Zapo.

Corpo (JSON)

{
  "ticketId": 1262,
  "body": {
    "text": "Copie seu código de rastreio:"
  },
  "footer": {
    "text": "Válido por 24h"
  },
  "displayText": "Copiar código",
  "copyCode": "BR123456789"
}

Enviar botão CTA de abrir URL via Zapo.

Corpo (JSON)

{
  "ticketId": 1262,
  "body": {
    "text": "Acesse nosso site:"
  },
  "footer": {
    "text": "Clique para visitar"
  },
  "displayText": "Visitar site",
  "url": "https://exemplo.com"
}

Enviar botão CTA de ligar (link tel:) via Zapo.

Corpo (JSON)

{
  "ticketId": 1262,
  "body": {
    "text": "Precisa de ajuda?"
  },
  "footer": {
    "text": "Ligue para nós"
  },
  "displayText": "Ligar agora",
  "phoneNumber": "+5511999999999"
}

Enviar enquete com múltiplas opções via Zapo.

Corpo (JSON)

{
  "ticketId": 1262,
  "name": "Qual sua preferência?",
  "options": [
    "Opção A",
    "Opção B",
    "Opção C"
  ],
  "selectableCount": 1
}

Criar um novo kanban. Esta rota não define cor: o kanban nasce sem cor e ela só pode ser ajustada pelo painel.

Corpo (JSON)

{
  "name": "Kanban 1",
  "position": 1
}

Atualizar um kanban existente. Esta rota não altera a cor: a cor atual é preservada e só pode ser ajustada pelo painel.

Parâmetros de caminho

Corpo (JSON)

{
  "name": "Kanban Atualizado",
  "position": 2
}

Excluir um kanban pelo ID.

Parâmetros de caminho

Corpo (JSON)

{}

Listar tickets com filtros de status, fila e canal.

Query params

Listar oportunidades com paginação e filtros.

Query params

Listar contatos com paginação e filtros. Cada contato traz o endereço: cep, logradouro, numeroEndereco, complemento, bairro, cidade e estado.

Query params

Listar tags disponíveis.

Query params

Enviar mensagem via query params (GET). Útil para integrações simples sem body. É a única rota do catálogo que não aceita o token no header Authorization: o token vai obrigatoriamente no parâmetro bearertoken. Nos canais whatsapp e baileys, número sem WhatsApp responde 424 ERR_WAPP_CONTACT_UNVERIFIED (número sem WhatsApp ou consulta ao WhatsApp indisponível no momento; pode tentar de novo); no baileys, canal aguardando a leitura do QR responde 400 ERR_CHANNEL_DISCONNECTED.

Query params

Enviar mensagem de texto. Abre ou reutiliza ticket existente. O campo number carrega o ID da plataforma do canal do token: telefone (família WhatsApp), IGSID (Instagram), PSID (Messenger), telegramId (Telegram). O canal e-mail também exige number (ou bsuid) e usa email como destinatário e subject como assunto. Aceita ticketId opcional — usado apenas quando consistente com o contato/canal do ticket. body em número vira texto; objeto ou lista responde 400 ERR_INVALID_BODY. Nos canais whatsapp e baileys, número sem WhatsApp responde 424 ERR_WAPP_CONTACT_UNVERIFIED (número sem WhatsApp ou consulta ao WhatsApp indisponível no momento; pode tentar de novo); no baileys, canal aguardando a leitura do QR responde 400 ERR_CHANNEL_DISCONNECTED.

Corpo (JSON)

{
  "body": "A mensagem desejada",
  "number": "5511999999999",
  "externalKey": "chave-001",
  "isClosed": false
}

Enviar arquivo via multipart/form-data (imagem, documento, vídeo).

Corpo (form-data)

Enviar mídia a partir de URL pública (imagem, documento). body (legenda) em número vira texto; objeto ou lista responde 400 ERR_INVALID_BODY. Nos canais whatsapp e baileys, número sem WhatsApp responde 424 ERR_WAPP_CONTACT_UNVERIFIED (número sem WhatsApp ou consulta ao WhatsApp indisponível no momento; pode tentar de novo); no baileys, canal aguardando a leitura do QR responde 400 ERR_CHANNEL_DISCONNECTED.

Corpo (JSON)

{
  "mediaUrl": "https://exemplo.com/imagem.png",
  "body": "A mensagem desejada",
  "number": "5511999999999",
  "externalKey": "chave-001",
  "isClosed": false
}

Enviar áudio/mensagem de voz via URL pública (.ogg, .mp3). No baileys, número sem WhatsApp responde 424 ERR_WAPP_CONTACT_UNVERIFIED (número sem WhatsApp ou consulta ao WhatsApp indisponível no momento; pode tentar de novo) e canal aguardando a leitura do QR, 400 ERR_CHANNEL_DISCONNECTED.

Corpo (JSON)

{
  "audio": "https://exemplo.com/audio.ogg",
  "number": "5511999999999",
  "externalKey": "chave-001",
  "isClosed": false
}

Enviar arquivo codificado em Base64 junto com mensagem. body (legenda) em número vira texto; objeto ou lista responde 400 ERR_INVALID_BODY. Nos canais whatsapp e baileys, número sem WhatsApp responde 424 ERR_WAPP_CONTACT_UNVERIFIED (número sem WhatsApp ou consulta ao WhatsApp indisponível no momento; pode tentar de novo); no baileys, canal aguardando a leitura do QR responde 400 ERR_CHANNEL_DISCONNECTED.

Corpo (JSON)

{
  "body": "A mensagem desejada",
  "number": "5511999999999",
  "base64Data": "iVBORw0KGgoAAAANSUhEUgAAAAUA...",
  "mimeType": "image/png",
  "fileName": "exemplo",
  "isClosed": false
}

Buscar mensagem pelo ID retornado pela Meta (wamid).

Query params

Enviar localização geográfica para um contato. O destinatário vem de number; ticketId é obrigatório e é o atendimento em que a mensagem fica registrada (sem ele 400 ERR_MISSING_TICKET; atendimento que não é da sua empresa 404 ERR_TICKET_NOT_FOUND).

Corpo (JSON)

{
  "number": "5511999999999",
  "latitude": -23.5505,
  "longitude": -46.6333,
  "name": "São Paulo",
  "address": "Av. Paulista, 1000",
  "ticketId": 1262
}

Enviar contato (vCard). O destinatário vem de number; ticketId é obrigatório e é o atendimento em que a mensagem fica registrada (sem ele 400 ERR_MISSING_TICKET; atendimento que não é da sua empresa 404 ERR_TICKET_NOT_FOUND). Dentro de contact, os campos fullName, wuid e phoneNumber são obrigatórios.

Corpo (JSON)

{
  "number": "5511999999999",
  "contact": {
    "fullName": "Nome Contato",
    "wuid": "5511888888888",
    "phoneNumber": "5511888888888",
    "organization": "Empresa Exemplo",
    "email": "contato@email.com"
  },
  "ticketId": 1262
}

Buscar mensagens por texto dentro de um ticket.

Query params

Enviar mensagem de texto para grupo do WhatsApp. Sem body (e sem arquivo) responde 400 ERR_MISSING_BODY_OR_MEDIA; body em número vira texto e objeto ou lista responde 400 ERR_INVALID_BODY. No baileys, canal aguardando a leitura do QR responde 400 ERR_CHANNEL_DISCONNECTED.

Corpo (JSON)

{
  "body": "A mensagem desejada",
  "number": "12356818915189153",
  "externalKey": "chave-001",
  "isClosed": false
}

Enviar arquivo para grupo via multipart/form-data. Um arquivo por requisição.

Corpo (form-data)

Enviar mídia por URL para grupo do WhatsApp.

Corpo (JSON)

{
  "mediaUrl": "https://exemplo.com/imagem.png",
  "body": "A mensagem desejada",
  "number": "12356818915189153",
  "externalKey": "chave-001",
  "isClosed": false
}

Criar um novo motivo de encerramento. Esta rota não define cor: o motivo nasce sem cor e ela só pode ser ajustada pelo painel.

Corpo (JSON)

{
  "name": "Resolvido"
}

Atualizar um motivo existente. Esta rota não altera a cor: a cor atual é preservada e só pode ser ajustada pelo painel.

Parâmetros de caminho

Corpo (JSON)

{
  "name": "Resolvido (atualizado)"
}

Excluir um motivo pelo ID.

Parâmetros de caminho

Corpo (JSON)

{}

Criar nova oportunidade vinculada a um contato (number; contactName e email são usados só se o contato ainda não existir). Obrigatórios: number, name (até 255 caracteres), pipelineId, stageId (etapa desse funil) e responsibleId (usuário da empresa). Opcionais: value (número, ex.: 1500.50), status (open, win ou lose), description e closingForecast, aceito só como AAAA-MM-DD, DD/MM/AAAA ou data e hora ISO 8601 (ex.: 2024-12-31T18:00:00-03:00). Outros campos do corpo são ignorados. Erros (400): ERR_MISSING_FIELDS (com fields), ERR_INVALID_OPPORTUNITY_REFERENCE (com field: funil, etapa ou responsável inexistente ou de outra empresa), ERR_STAGE_NOT_IN_PIPELINE, ERR_INVALID_OPPORTUNITY_NAME, ERR_INVALID_VALUE, ERR_INVALID_STATUS, ERR_INVALID_DESCRIPTION e ERR_INVALID_CLOSING_FORECAST.

Corpo (JSON)

{
  "number": "5511999999999",
  "contactName": "Nome do Contato",
  "email": "contato@email.com",
  "name": "Nome da Oportunidade",
  "value": 10000,
  "status": "open",
  "pipelineId": 16,
  "stageId": 7,
  "responsibleId": 1,
  "closingForecast": "2024-12-31",
  "description": "Descrição da oportunidade"
}

Excluir uma oportunidade pelo ID.

Corpo (JSON)

{
  "opportunityId": 19
}

Atualizar dados de uma oportunidade existente. Só opportunityId é obrigatório; campo ausente fica como está; nos demais, vazio ou null também fica como está, exceto description e closingForecast, em que vazio ou null limpam o valor. Mesmas regras do CreateOpportunity: pipelineId, stageId e responsibleId da empresa, etapa do funil da oportunidade (ou do pipelineId enviado; trocar de funil exige stageId desse funil), value numérico, status open, win ou lose e closingForecast em AAAA-MM-DD, DD/MM/AAAA ou data e hora ISO 8601. Erros: 404 ERR_OPPORTUNITY_NOT_FOUND; 400 ERR_INVALID_OPPORTUNITY_REFERENCE (com field), ERR_STAGE_NOT_IN_PIPELINE, ERR_INVALID_OPPORTUNITY_NAME, ERR_INVALID_VALUE, ERR_INVALID_STATUS, ERR_INVALID_DESCRIPTION e ERR_INVALID_CLOSING_FORECAST.

Corpo (JSON)

{
  "opportunityId": 30,
  "name": "Nome Atualizado",
  "value": 500,
  "status": "open",
  "pipelineId": 16,
  "stageId": 7,
  "responsibleId": 1,
  "closingForecast": "2024-12-31",
  "description": "Descrição atualizada"
}

Criar uma nova tag. O nome da tag vai no campo tag. tag e color são obrigatórios. Nome já usado na empresa responde 409 ERR_TAG_DUPLICATED; nome, cor ou palavras-gatilho acima de 255 caracteres respondem 400 ERR_TAG_TOO_LONG.

Corpo (JSON)

{
  "tag": "Tag Nova",
  "color": "#FF5733",
  "isActive": true
}

Atualizar dados de uma tag existente. O nome da tag vai no campo tag. Nome de outra tag da empresa responde 409 ERR_TAG_DUPLICATED; nome, cor ou palavras-gatilho acima de 255 caracteres respondem 400 ERR_TAG_TOO_LONG.

Parâmetros de caminho

Corpo (JSON)

{
  "tag": "Tag Atualizada",
  "color": "#33A1FF",
  "isActive": true
}

Excluir uma tag pelo ID.

Parâmetros de caminho

Corpo (JSON)

{}

Enviar template aprovado do WhatsApp Business API (WABA). A resposta retorna o ticketId do atendimento criado/reutilizado. templateData é objeto (texto JSON também é aceito) e template.components precisa ser lista: fora disso responde 400 ERR_INVALID_TEMPLATE_DATA ou ERR_INVALID_TEMPLATE_COMPONENTS.

Corpo (JSON)

{
  "number": "5511999999999",
  "isClosed": false,
  "templateData": {
    "messaging_product": "whatsapp",
    "to": "5511999999999",
    "type": "template",
    "template": {
      "name": "hello_world",
      "language": {
        "code": "pt_BR"
      }
    }
  }
}

Enviar template WABA com parâmetros de body personalizados. A resposta retorna o ticketId do atendimento criado/reutilizado. templateData é objeto (texto JSON também é aceito) e components precisa ser lista; text de parâmetro e variables em número viram texto, e objeto ou lista nesses campos responde 400 ERR_INVALID_TEMPLATE_PARAMETER. Fora do formato: 400 ERR_INVALID_TEMPLATE_DATA ou ERR_INVALID_TEMPLATE_COMPONENTS.

Corpo (JSON)

{
  "number": "5511999999999",
  "isClosed": false,
  "templateData": {
    "messaging_product": "whatsapp",
    "to": "5511999999999",
    "type": "template",
    "template": {
      "name": "hello_world",
      "language": {
        "code": "pt_BR"
      },
      "components": [
        {
          "type": "body",
          "parameters": [
            {
              "type": "text",
              "text": "valor1"
            }
          ]
        }
      ]
    }
  }
}

Enviar template de marketing WABA com componentes de header e body. A resposta retorna o ticketId do atendimento criado/reutilizado. templateData é objeto (texto JSON também é aceito) e components precisa ser lista; text de parâmetro e variables em número viram texto, e objeto ou lista nesses campos responde 400 ERR_INVALID_TEMPLATE_PARAMETER. Fora do formato: 400 ERR_INVALID_TEMPLATE_DATA ou ERR_INVALID_TEMPLATE_COMPONENTS.

Corpo (JSON)

{
  "number": "5511999999999",
  "isClosed": false,
  "templateData": {
    "messaging_product": "whatsapp",
    "to": "5511999999999",
    "type": "template",
    "template": {
      "name": "nome_template_marketing",
      "language": {
        "code": "pt_BR"
      },
      "components": [
        {
          "type": "header",
          "parameters": [
            {
              "type": "image",
              "image": {
                "link": "https://exemplo.com/img.png"
              }
            }
          ]
        },
        {
          "type": "body",
          "parameters": [
            {
              "type": "text",
              "text": "valor1"
            }
          ]
        }
      ]
    }
  }
}

Criar ticket de atendimento. Suporta WhatsApp e Webmail.

Corpo (JSON)

{
  "body": "Mensagem inicial",
  "number": "5511999999999",
  "externalKey": "chave-001",
  "userId": 1,
  "status": "pending",
  "queueId": null,
  "kanbanId": null,
  "chatFlowId": null,
  "reasonId": null,
  "value": null
}

Criar ticket via canal Webmail (email).

Corpo (JSON)

{
  "body": "Mensagem via email",
  "email": "contato@exemplo.com",
  "channelId": 17841443941506796,
  "externalKey": "chave-001",
  "userId": 1,
  "status": "pending",
  "name": "Nome do Contato"
}

Criar ticket enviando um arquivo (multipart/form-data). Suporta imagem, documento e outros formatos.

Corpo (form-data)

Definir ou alterar a fila de atendimento de um ticket.

Corpo (JSON)

{
  "ticketId": 4,
  "queueId": 1
}

Substituir as tags do contato do ticket pela tag informada. Atenção: as demais tags do contato são removidas, e o efeito vale para todos os tickets desse contato. Para acrescentar sem remover, use /addTag.

Corpo (JSON)

{
  "ticketId": 4,
  "tag": 1
}

Atualizar informações completas de um ticket. ticketId é o id numérico do ticket (400 ERR_INVALID_TICKET_ID). status aceita open, pending ou closed (400 ERR_INVALID_STATUS). typebotStatus, lmStatus, chatgptStatus, dialogflowStatus, difyStatus e n8nStatus aceitam true/false (também "enabled"/"disabled" e 1/0; outro valor responde 400 ERR_INVALID_FIELD com o campo em field). queueId, userId e chatFlowId precisam existir na sua empresa (senão 404 ERR_QUEUE_NOT_FOUND, ERR_USER_NOT_FOUND ou ERR_CHATFLOW_NOT_FOUND); null limpa o campo.

Corpo (JSON)

{
  "ticketId": 1262,
  "userId": 1,
  "status": "pending",
  "queueId": null,
  "typebotStatus": false,
  "chatgptStatus": false,
  "dialogflowStatus": false,
  "difyStatus": false,
  "n8nStatus": false,
  "chatFlowId": null
}

Buscar informações de um ticket aberto do contato. Só considera tickets com status open: contato sem ticket aberto responde 404, mesmo tendo histórico. Havendo mais de um aberto, não há garantia de que seja o mais recente.

Corpo (JSON)

{
  "number": "5511999999999"
}

Buscar o primeiro ticket do contato que tenha fluxo de chatbot vinculado, independente do status. Ticket fechado com fluxo também é retornado; ticket aberto sem fluxo responde 404.

Corpo (JSON)

{
  "number": "5511999999999"
}

Buscar todos os tickets de um contato pelo número.

Corpo (JSON)

{
  "number": "5511999999999"
}

Listar todas as mensagens de um ticket. Informe o id em ticket (ou ticketId); sem ele responde 400 ERR_MISSING_TICKET.

Corpo (JSON)

{
  "ticket": "123"
}

Alterar o canal (WhatsApp) de um ticket existente.

Corpo (JSON)

{
  "ticketId": 1262,
  "whatsappId": 1,
  "channel": "whatsapp"
}

Criar uma nota interna em um ticket. ticketId é obrigatório (400 ERR_MISSING_FIELDS). idFront é opcional: quando informado, uma nota com o mesmo idFront não é criada de novo.

Corpo (JSON)

{
  "notes": "Conteúdo da nota",
  "ticketId": 1262,
  "userId": 1,
  "idFront": "ID_UNICA_NOTA_001"
}

Atualizar o conteúdo de uma nota existente.

Corpo (JSON)

{
  "noteId": 1,
  "notes": "Conteúdo atualizado"
}

Listar todas as notas de um ticket.

Query params

Adicionar uma ou mais tags a um ticket.

Corpo (JSON)

{
  "ticketId": 4,
  "tagId": 1
}

Remover uma ou mais tags de um ticket.

Corpo (JSON)

{
  "ticketId": 4,
  "tagId": 1
}

Adicionar uma ou mais tags diretamente a um CONTATO, sem precisar de ticket. Informe contactId OU number. Mantém as tags existentes.

Corpo (JSON)

{
  "contactId": 123,
  "tagId": 1
}

Remover uma ou mais tags diretamente de um CONTATO, sem precisar de ticket. Informe contactId OU number.

Corpo (JSON)

{
  "number": "5511999999999",
  "tagIds": [
    1,
    2
  ]
}

Enviar estado de presença (digitando, gravando, etc). Nos canais oficiais (WhatsApp Business oficial e 360dialog) só typing funciona, e a Meta marca como lida a última mensagem recebida do contato; recording, paused e o canal Gupshup respondem 400 ERR_PRESENCE_NOT_SUPPORTED.

Corpo (JSON)

{
  "ticketId": 1262,
  "state": "typing"
}

Buscar dados completos de um ticket pelo ID.

Corpo (JSON)

{
  "ticketId": 1262
}

Iniciar pausa em um ticket (para controle de SLA).

Parâmetros de caminho

Corpo (JSON)

{
  "pauseReason": "Aguardando retorno do cliente"
}

Encerrar pausa de um ticket.

Parâmetros de caminho

Corpo (JSON)

{}

Parâmetros de caminho

Listar avaliações de atendimento.

Query params

Enviar a pesquisa de satisfação para um atendimento e registrar a avaliação pendente (a nota do cliente é capturada automaticamente). Informe ticketId OU number (usa o ticket aberto do contato). Respeita o modo configurado (escala nativa ou link externo). Recusa grupos e canais sem suporte; retorna 409 se já houver avaliação pendente do contato (use force para reenviar).

Corpo (JSON)

{
  "ticketId": 1262,
  "body": "",
  "externalKey": "",
  "force": false
}

Compartilhar um ticket com outros usuários. Os usuários que ganham acesso vão em userIdArray. Um ticket só aceita um convite de compartilhamento: repetir a chamada responde 400.

Corpo (JSON)

{
  "ticketId": 1262,
  "userIdArray": [
    2
  ],
  "inviteUrl": ""
}

Parâmetros de caminho

Criar uma nova tarefa no to-do list.

Corpo (JSON)

{
  "name": "Ligar para o cliente",
  "description": "Retornar sobre a proposta enviada",
  "limitDate": "2026-06-15",
  "owner": "João Silva",
  "ownerId": 1,
  "status": "pending",
  "priority": "high",
  "comments": "Cliente pediu retorno pela manhã"
}

Atualizar uma tarefa existente.

Parâmetros de caminho

Corpo (JSON)

{
  "name": "Tarefa atualizada",
  "status": "finished",
  "priority": "medium"
}