Comece por aqui
A API da PicChat conecta o seu sistema à sua conta: você consulta conversas, contatos e campanhas, mantém os contatos atualizados a partir do seu CRM ou site e dispara mensagens de WhatsApp pelas automações que já existem no painel. Tudo com o token da própria conta, sem contratar nada à parte.
Esta documentação cobre a API que qualquer conta PicChat pode usar. Se você só quer consultar a sua conta conversando com o Claude, vá direto para o MCP — ele usa esta mesma API por baixo.
O que dá pra fazer
| Você quer… | Use |
|---|---|
| Ler tíquetes, mensagens, contatos, listas, campanhas, automações, canais, templates e assistentes | Consultas /v1 |
| Criar ou atualizar um contato vindo do seu site, CRM ou formulário | POST /contacts/create-or-update |
| Gravar propriedades personalizadas num contato (etapa do funil, plano, cidade…) | Propriedades no create-or-update |
| Enviar uma mensagem de WhatsApp para um ou vários contatos | Disparo por automação |
| Consultar a conta pelo Claude, sem escrever código | MCP |
Ambiente e base URL
| Ambiente | Base URL |
|---|---|
| Produção | https://api.picchat.com.br |
Não existe sandbox. Toda chamada age na sua conta de verdade:
POSTcria contatos e dispara mensagens reais, que consomem créditos. Para testar, use um contato seu e uma automação de teste (veja Como funciona o envio).
Integrações antigas que usam https://apiv1.picchat.io continuam funcionando, mas use https://api.picchat.com.br em tudo que for novo.
Autenticação
Toda requisição leva o token da conta no header Authorization:
Authorization: Bearer SEU_TOKENO token é gerado no painel em Configurações → Integrações (abrir) e aparece uma vez só — guarde num cofre de segredos. Ele age como o usuário que o criou: enxerga o que esse usuário enxerga no painel. Detalhes em Autenticação e tokens.
| Situação | Resposta |
|---|---|
| Token ausente, inválido ou revogado | 498 · errorCode API_TOKEN_INVALID ou API_TOKEN_REVOKED |
| Usuário do token sem permissão para a consulta | 403 · API_V1_PERMISSION_DENIED |
account_id de outra conta na query ou no corpo |
403 · API_ACCOUNT_ID_NOT_IN_TOKEN |
Todos os erros seguem o mesmo formato — veja Códigos HTTP e erros.
A API responde 498 (e não 401) para token inválido. Trate os dois códigos do mesmo jeito no seu cliente HTTP.
Primeira chamada em 2 minutos
- Gere um token em Configurações → Integrações.
- Rode no terminal:
curl https://api.picchat.com.br/v1/me \
--header 'Authorization: Bearer SEU_TOKEN'- A resposta traz a conta do token — nome, plano, créditos, canais e usuários — e, em
access, quem é o usuário, o grupo de permissão e o que ele pode consultar. Se chegou aqui, o token funciona.
Prefere testar sem terminal? Cada página da API Reference tem um console: cole o token na coluna da direita e clique em Testar requisição.
Como esta documentação está organizada
- Guias — o passo a passo de cada caso de uso, com exemplos completos.
- API Reference — cada endpoint com parâmetros, respostas, exemplos em cURL, Node, Python e PHP e o console para testar.
- MCP — como ligar a sua conta ao Claude (claude.ai, Claude Code, Claude Desktop, Cursor).
- Changelog — o que mudou e quando.
Em qualquer página, o botão Copiar para IA copia o conteúdo em Markdown para você colar no seu assistente. O índice completo para agentes fica em /llms.txt.