Documentação da API
Integre seus sistemas ao CRM de conversas do Prosalab pela API pública v1 — REST, JSON e autenticação por chave.
A API pública do Prosalab (v1) permite integrar sistemas externos ao seu CRM de conversas: gerenciar contatos, listas e campos personalizados, criar e disparar campanhas, enviar mensagens avulsas ou por template, consultar o histórico de mensagens, importar contatos em massa e receber eventos em tempo real via webhooks.
A URL base de todas as chamadas é:
https://www.prosalab.comA API segue o padrão REST: recursos identificados por URL, verbos HTTP (GET, POST, PATCH, DELETE) e corpo em JSON — tanto na requisição quanto na resposta.
Fluxo mínimo
1. Acesse Configurações → API dentro da plataforma e crie uma chave (nome + os escopos necessários para o seu caso de uso).
2. Copie o valor da chave — ele é exibido uma única vez, no momento da criação.
3. Faça a primeira chamada autenticada. Exemplo: listar as campanhas da empresa.
curl -X GET "https://www.prosalab.com/api/v1/campaigns" \
-H "Authorization: Bearer <sua-key>"A partir daqui, consulte os capítulos Autenticação, Erros, Limites de requisição e Paginação para os detalhes transversais, e a navegação lateral para a referência completa de cada recurso (contatos, campanhas, mensagens, webhooks e demais).
Esta é a versão v1 da API — todas as rotas documentadas aqui vivem sob o prefixo /api/v1.
Recursos da API
Referência completa de cada família de endpoints.
Contatos
Gerencie os contatos da empresa com dados de CRM: listagem com filtros, detalhe completo (etiquetas, etapa de pipeline, campos personalizados, conexões), criação, atualização parcial e remoção. Todos os endpoints exigem plano Enterprise.
Envio de mensagens
Envie mensagens de texto e templates (HSM) da Meta via WhatsApp. O contato é criado automaticamente se ainda não existir. O connection_id é opcional — sem ele, a conexão padrão da empresa é usada.
Mensagens
Consulte o histórico de mensagens da empresa — a lista geral com filtros ou o histórico de um contato específico. Ambos exigem plano Enterprise e são paginados.
Listas
Crie e gerencie listas (etiquetas) para segmentar contatos, e associe/desassocie contatos em lote. A remoção é soft delete (a lista fica inativa). Todos os endpoints exigem plano Enterprise.
Campos personalizados
Defina campos personalizados de contato. O id retornado aqui é a CHAVE de custom_fields em TODA a API — tanto ao criar/atualizar/importar quanto no detalhe do contato — e é aqui que moram o rótulo e o tipo de cada campo. O slug é derivado do label pelo servidor e é imutável após a criação. A remoção é soft delete. Todos os endpoints exigem plano Enterprise.
Campanhas
Liste campanhas, acompanhe métricas de entrega, adicione destinatários e controle o ciclo de vida (iniciar, pausar, retomar). Alguns endpoints (adicionar destinatários e relatório consolidado) exigem plano Enterprise.
Importação em massa
Importe até 10.000 contatos por job (máx. 4MB), processados em fila com upsert idempotente. O endpoint responde 202 com um job_id que você consulta para acompanhar o progresso. Exige plano Enterprise.
Conexões
Liste as conexões da empresa (WhatsApp, Instagram) com o estado de cada uma. Exige plano Enterprise.
Etapas de pipeline
Liste as etapas do pipeline de CRM da empresa. Exige plano Enterprise.
Webhooks
Webhooks completam a integração com a Prosalab: a plataforma AVISA seus sistemas quando algo acontece (outbound) e RECEBE dados de sistemas externos pra criar/atualizar contatos ou disparar templates (inbound).