> ## Documentation Index > Fetch the complete documentation index at: https://developer.wabox.me/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Wabox é uma API não-oficial de WhatsApp (aparelho vinculado). Tudo é snake_case; a base é https://api.wabox.me/instances/{instance_id}/token/{token}. > Envios respondem { id, message_id, wabox_id, status: "queued" } na hora; o resultado real chega no webhook delivery. Envios não são idempotentes: confira GET /queue antes de repetir. > Sempre verifique X-Wabox-Signature (HMAC-SHA256 de ".") nos webhooks e deduplique por event_id. > Botões, listas, carrossel e catálogo são best effort e não renderizam no WhatsApp Web/Desktop. Não existem: chamadas, listas de transmissão, histórico de mensagens, instância mobile. > Não invente endpoints ou campos: use o OpenAPI em https://api.wabox.me/openapi.json. # Criar canal > Você passa a ser o dono. `picture` opcional (JPEG/PNG, por URL ou base64). Para publicar em um canal seu, use qualquer endpoint `send-*` com `phone: "@newsletter"`. Imediata: exige a instância conectada (caso contrário, 409 `instance_not_connected`). ## OpenAPI ````yaml /openapi.json post /instances/{instance_id}/token/{token}/newsletters openapi: 3.1.0 info: title: Wabox API description: >- API pública do Wabox — WhatsApp via REST + webhooks. Base: `{server}/instances/{instance_id}/token/{token}`. Header `Client-Token` obrigatório quando ativado em Segurança. Tudo em `snake_case`. Datas ISO-8601 (UTC). Erros: `{ "error": { "code": "...", "message": "..." } }`. Envios respondem `{ id, message_id, wabox_id, status: "queued" }` na hora; o resultado chega no webhook `delivery`. `message_id` já é o id definitivo do WhatsApp. version: '1.0' contact: {} servers: - url: https://api.wabox.me security: [] tags: - name: Instance description: >- Conexão (QR code / código de pareamento), status, webhooks e configurações da instância. x-group: Instância - name: Messages description: >- Envio de texto, mídia, localização, contatos, reações, enquetes e ações sobre mensagens. Tudo passa pela fila; o resultado chega no webhook `delivery`. x-group: Mensagens - name: Interactive description: >- Botões, listas, carrossel, PIX, eventos de calendário, status (stories) e convite de canal. Best effort: renderizam no celular; o WhatsApp Web/Desktop não exibe botões, listas nem carrossel. x-group: Interativos - name: Queue description: Mensagens aguardando envio (pacing anti-ban ou instância desconectada). x-group: Fila - name: Chats description: >- Lista de conversas, ações (arquivar, silenciar, fixar, ler) e mensagens temporárias. x-group: Chats - name: Contacts description: Contatos, foto de perfil, verificação de números e bloqueio. x-group: Contatos - name: Profile description: Nome, recado e foto do número conectado. x-group: Perfil - name: Groups description: >- Criar, listar, administrar participantes, links de convite e configurações. x-group: Grupos - name: Communities description: Comunidades e vínculo de grupos. x-group: Comunidades - name: Newsletters description: >- Canais (newsletters): criar, seguir, ler e reagir a posts. Para publicar, use qualquer `send-*` com `phone: @newsletter`. x-group: Canais - name: Privacy description: Configurações de privacidade da conta. x-group: Privacidade - name: Business description: >- Perfil comercial, catálogo de produtos, pedidos e envio de produto/catálogo/pedido. Best effort: depende do protocolo do WhatsApp Web. x-group: Business e catálogo - name: Labels description: Etiquetas (labels) de conversas — só em contas WhatsApp Business. x-group: Etiquetas - name: Partner description: >- Para integradores: criar e administrar instâncias do próprio workspace Partner com o header `Partner-Token` (base `/partner`, sem `instance_id`/`token` na URL). As instâncias criadas aqui são operadas pela API pública normal e não têm trial nem `402`. x-group: Partner - name: Webhooks description: Eventos entregues por `POST` na URL configurada em cada instância. x-group: Webhooks paths: /instances/{instance_id}/token/{token}/newsletters: post: tags: - Newsletters summary: Criar canal description: >- Você passa a ser o dono. `picture` opcional (JPEG/PNG, por URL ou base64). Para publicar em um canal seu, use qualquer endpoint `send-*` com `phone: "@newsletter"`. Imediata: exige a instância conectada (caso contrário, 409 `instance_not_connected`). operationId: newsletters.create parameters: - name: instance_id required: true in: path description: Id da instância (dashboard › instância › Credenciais). schema: type: string example: 8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b - name: token required: true in: path description: Token da instância. Trate como senha. schema: type: string example: 3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 2048 picture: type: string minLength: 1 maxLength: 94371840 description: URL http(s) pública, `data:` URL ou base64 puro. picture_mime_type: type: string minLength: 1 maxLength: 255 required: - name examples: basico: summary: Nome e descrição value: name: Canal Wabox description: Novidades da API com_foto: summary: Com foto por URL value: name: Canal Wabox description: Novidades da API picture: https://exemplo.com/logo.png picture_mime_type: image/png responses: '200': description: 'Canal criado (`role: "owner"`).' content: application/json: schema: $ref: '#/components/schemas/Newsletter' example: id: 120363999999999999@newsletter name: Canal Wabox description: Novidades da API invite_code: 0029VaAbCdEfGhIjKlMn1o invite_url: https://whatsapp.com/channel/0029VaAbCdEfGhIjKlMn1o subscriber_count: 1234 verified: false state: active picture_url: https://pps.whatsapp.net/v/t61.24694-24/abc.jpg role: owner muted: false created_at: '2026-06-01T10:00:00.000Z' reactions_mode: all '401': description: Instância/token inválidos ou `Client-Token` ausente. content: application/json: schema: $ref: '#/components/schemas/ApiError' example: error: code: instance_not_found message: Instance not found or invalid token '402': description: Trial expirado ou assinatura inativa. content: application/json: schema: $ref: '#/components/schemas/ApiError' example: error: code: subscription_required message: >- Trial expired or subscription inactive. Subscribe in the dashboard to keep sending. '409': description: Instância não conectada. content: application/json: schema: $ref: '#/components/schemas/ApiError' example: error: code: instance_not_connected message: Instance is not connected x-codeSamples: - lang: typescript label: TypeScript (@wabox/sdk) source: | import { createWabox } from "@wabox/sdk"; const wabox = createWabox({ instanceId: process.env.WABOX_INSTANCE_ID!, token: process.env.WABOX_TOKEN!, }); const { data, error } = await wabox.POST("/newsletters", { body: { name: "Canal Wabox", description: "Novidades da API" }, }); if (error) throw new Error(error.error.message); console.log(data); components: schemas: Newsletter: type: object properties: id: type: string pattern: ^\d+@newsletter$ name: type: string description: type: string invite_code: type: string invite_url: type: string format: uri subscriber_count: type: integer minimum: 0 maximum: 9007199254740991 verified: type: boolean state: type: string enum: - active - suspended - geosuspended picture_url: type: string role: type: string enum: - owner - admin - subscriber - guest muted: type: boolean created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ reactions_mode: type: string enum: - all - basic - none - blocklist required: - id - name - subscriber_count - verified - state - muted additionalProperties: false ApiError: type: object properties: error: type: object properties: code: type: string description: >- Código estável do erro (`instance_not_found`, `invalid_request`…). message: type: string description: Descrição legível, em inglês. details: description: 'Contexto extra (ex.: `issues` de validação).' type: object additionalProperties: {} required: - code - message additionalProperties: false required: - error additionalProperties: false ````