Primeiros passos
Introdução
Visão geral da API Wizy Marketing, recursos disponíveis e como começar sua integração.
Comece rapidamente
Gere uma API Key, envie o header de autenticação e chame os endpoints — ou conecte qualquer IA compatível com MCP (Cursor, Claude, ChatGPT, Copilot, Gemini, Windsurf e outras) via MCP. Mensagens agendadas pela API aparecem na tela Agendamentos do Wizy Marketing.
URL base
Todos os endpoints são acessados a partir da URL base abaixo. Use HTTPS em todas as requisições.
https://api.Wizy Marketing.com.br
Autenticação
Gere uma API Key no app Wizy Marketing (prefixo sk_). Envie o header Authorization: Bearer sk_… em todas as requisições. Veja API Keys.
Formato das respostas
Respostas bem-sucedidas retornam HTTP 2xx com um objeto JSON (ok: true). Erros retornam 4xx ou 5xx com corpo padronizado (ok: false, error).
Recursos da API
- Autenticação — API Keys Bearer, scopes e sandbox
- MCP - Use o Wizy Marketing dentro da sua IA — mesma key, tools para Cursor, Claude, ChatGPT, Copilot, Gemini, Windsurf e outras
- Contatos — CRUD completo com PATCH
- Mensagens — envio, templates, reações, leitura, grupos WA e Meta
- Agendamentos — agendar, listar, consultar e cancelar
- Listas & grupos — etiquetas e grupos WhatsApp
- Automações — fluxos e templates
- CRM — funis, etapas, mover contato e campos personalizados
- Campanhas — criar, destinatários, pausar e retomar
- Follow-ups — criar, atualizar e cancelar
- Agentes — listar, configurar e disparar
- Telegram — conexões e envio
- Mídia — upload JSON (base64) ou multipart
- Tarefas — CRUD de tarefas
- Webhooks — eventos e histórico de entregas
- Instâncias & ops — status, QR, handoff, retomar IA e conversões
Discovery
- DELETE /api/contacts/:id
- DELETE /api/flows/:id
- DELETE /api/groups/:id
- DELETE /api/messages/:id
- DELETE /api/messages/schedule/:id
- DELETE /api/tasks/:id
- DELETE /api/webhooks/:id
- GET /api/agents
- GET /api/agents/:id
- GET /api/campaigns
- GET /api/campaigns/:id
- GET /api/campaigns/:id/recipients
- GET /api/connections
- GET /api/connections/:name/status
- GET /api/contacts
- GET /api/contacts/:id
- GET /api/custom-fields
- GET /api/flows
- GET /api/flows/:id
- GET /api/follow-ups
- GET /api/follow-ups/:id
- GET /api/funnels
- GET /api/funnels/:id/stages
- GET /api/groups
- GET /api/groups/:id/contacts
- GET /api/messages
- GET /api/messages/:id
- GET /api/messages/schedule
- GET /api/messages/schedule/:id
- GET /api/meta/templates
- GET /api/tasks
- GET /api/tasks/:id
- GET /api/telegram/connections
- GET /api/templates
- GET /api/webhooks
- GET /api/webhooks/deliveries
- GET /api/whatsapp-groups
- PATCH /api/agents/:id
- PATCH /api/contacts/:id
- PATCH /api/follow-ups/:id
- PATCH /api/tasks/:id
- POST /api/agents
- POST /api/agents/:id/trigger
- POST /api/campaigns
- POST /api/campaigns/:id/pause
- POST /api/campaigns/:id/resume
- POST /api/connections/:name/qr
- POST /api/contacts
- POST /api/contacts/:id/handoff
- POST /api/contacts/:id/move
- POST /api/contacts/:id/resume-ai
- POST /api/conversions/google
- POST /api/conversions/meta
- POST /api/flows
- POST /api/flows/:id/trigger
- POST /api/follow-ups
- POST /api/follow-ups/:id/cancel
- POST /api/groups
- POST /api/groups/:id/contacts
- POST /api/media/upload
- POST /api/messages/:id/react
- POST /api/messages/:id/read
- POST /api/messages/schedule
- POST /api/messages/send
- POST /api/messages/send-template
- POST /api/tasks
- POST /api/telegram/messages/send
- POST /api/webhooks/configure
- POST /api/whatsapp-groups/:jid/messages
- PUT /api/contacts/:id/custom-fields
- PUT /api/flows/:id
