{ "info": { "name": "ZapZap API", "description": "REST API to connect WhatsApp numbers by QR code and to send, receive and automate messages. Authenticate with the `x-api-key` and `x-api-secret` headers (Settings and API in the dashboard). The channel uses a QR code and is not Meta's official API: WhatsApp can restrict numbers that send unwanted messages. Docs: https://zapzapapi.com/en/docs", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "pm.request.headers.upsert({ key: 'x-api-secret', value: pm.variables.get('apiSecret') });" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://api.zapzapapi.com/api/v1" }, { "key": "apiKey", "value": "" }, { "key": "apiSecret", "value": "" }, { "key": "instanceId", "value": "" } ], "item": [ { "name": "Account and Instances", "item": [ { "name": "Account Details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/account", "host": [ "{{baseUrl}}" ], "path": [ "account" ] }, "description": "Returns your account data: name, email, current balance, billing day, and status." } }, { "name": "List Instances", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances", "host": [ "{{baseUrl}}" ], "path": [ "instances" ] }, "description": "Lists all WhatsApp instances in your account with status, name, phone, and settings." } }, { "name": "Create Instance", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances", "host": [ "{{baseUrl}}" ], "path": [ "instances" ] }, "description": "Creates a new WhatsApp instance. Automatically debits the balance (activation fee + prorated amount). The name must contain only letters, numbers, _ and -.", "body": { "mode": "raw", "raw": "{\n \"name\": \"minha-instancia\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Creation Cost", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/cost", "host": [ "{{baseUrl}}" ], "path": [ "instances", "cost" ] }, "description": "Returns the cost to create a new instance: activation fee, prorated amount, and required balance." } }, { "name": "Delete Instance", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}" ] }, "description": "Deletes (soft delete) an instance. WhatsApp is disconnected and an activation fee waiver is generated for the next creation." } }, { "name": "Instance Details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}" ] }, "description": "Returns details of a specific instance." } }, { "name": "Update Instance", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}" ] }, "description": "Updates the webhook_url and/or metadata of an instance. The metadata is free-form JSON to link the instance to your system (e.g. customer ID, plan, etc). The metadata is automatically included in the webhooks you receive.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Instance QR Code", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}/qrcode", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}", "qrcode" ] }, "description": "Returns the QR Code to connect WhatsApp to the instance. Scan it with your phone." } }, { "name": "View Webhook", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}", "webhook" ] }, "description": "Returns the webhook URL configured for the instance. The webhook receives real-time events (messages, status, etc).\n\n⚠️ URL WARNING: {id} is already in the path: do NOT add it twice.\n\n✅ Correct: GET /api/v1/instances/YOUR-INSTANCE-ID/webhook\n❌ Wrong: GET /api/v1/YOUR-INSTANCE-ID/instances/YOUR-INSTANCE-ID/webhook (duplicated instanceId)" } }, { "name": "Configure Webhook", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}", "webhook" ] }, "description": "Sets or updates the instance webhook URL. The URL must be public and reachable over HTTPS. Events such as received messages, delivery status, and connection changes will be sent via POST to this URL.\n\n⚠️ URL WARNING: {id} is already in the path: do NOT add it twice.\n\n✅ Correct: PUT /api/v1/instances/YOUR-INSTANCE-ID/webhook\n❌ Wrong: PUT /api/v1/YOUR-INSTANCE-ID/instances/YOUR-INSTANCE-ID/webhook (duplicated instanceId)", "body": { "mode": "raw", "raw": "{\n \"webhook_url\": \"https://meusite.com/webhook\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Test Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}/webhook/test", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}", "webhook", "test" ] }, "description": "Sends a test event to the configured webhook URL. Returns the status code and response time. Useful to validate that your server is receiving events correctly.\n\n⚠️ URL WARNING: {id} is already in the path: do NOT add it twice.\n\n✅ Correct: POST /api/v1/instances/YOUR-INSTANCE-ID/webhook/test\n❌ Wrong: POST /api/v1/YOUR-INSTANCE-ID/instances/YOUR-INSTANCE-ID/webhook/test (duplicated instanceId)", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "New Conversation Limits (WhatsApp)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/wa_messages_limits", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "wa_messages_limits" ] }, "description": "Queries the current limit of new conversations that WhatsApp allows starting from this number (the account 'tier'). Useful to track warm-up and avoid blocks from excessive sending." } } ] }, { "name": "Send Messages", "item": [ { "name": "Send Carousel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/carousel", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "carousel" ] }, "description": "Sends a carousel of cards with an image and action buttons. Each item of the `carousel` array represents a card with `text`, `image`, and `buttons: [{type,text,id}]`.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Confira nossas opções:\",\n \"carousel\": [\n {\n \"text\": \"Produto 1\",\n \"image\": \"https://exemplo.com/img.jpg\",\n \"buttons\": [\n {\n \"type\": \"REPLY\",\n \"text\": \"Quero!\",\n \"id\": \"quero\"\n }\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Contact (vCard)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/contact", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "contact" ] }, "description": "Sends a contact card (vCard) with name and phone.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"fullName\": \"João Silva\",\n \"phoneNumber\": \"5511999999999,5511888888888\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Location", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/location", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "location" ] }, "description": "Sends a geographic location with a map pin. The recipient can open it directly in Google Maps or Apple Maps.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"latitude\": -23.5505,\n \"longitude\": -46.6333\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Request Location", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/location-button", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "location-button" ] }, "description": "Sends a message with a button that asks for the user's location. The share location button is added automatically.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Compartilhe sua localização para entregarmos seu pedido:\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Media", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/media", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "media" ] }, "description": "Sends a media file to a contact. The file must be accessible at a public URL.\n\nAvailable types:\n• image: Image (JPG, PNG, GIF, WebP). Supports a caption via text.\n• video: Video (MP4, AVI, MOV). Supports a caption via text.\n• audio: Audio as a file (MP3, OGG, WAV). Appears with an audio file icon.\n• ptt: Push-to-Talk: audio that appears as a voice message (microphone bubble). Ideal for humanizing automations.\n• myaudio: Native WhatsApp audio (OGG/Opus). Similar to ptt, use it when you already have the file in the correct format.\n• ptv: Video message (round video note). Always arrives in circular format; 16:9 video is cropped at the center. Ignores the caption (the text field does not appear). Use MP4 H.264. Accepts long durations (tested 15 to 180 s) and size within the media limit.\n• document: Document (PDF, DOCX, XLSX, etc.). Use docName to set the name displayed in the chat.\n• sticker: Animated or static sticker (WebP).\n\nSize limit (sending by URL): image, video, and audio up to ~190 MB; document up to ~500 MB. Above that, WhatsApp rejects it (HTTP 413 / upload error). Note: when sending the file as base64 in the request body through the public API (/api/v1), the limit drops to ~2 MB. Therefore, for larger files, always send by URL.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"type\": \"\",\n \"file\": \"https://...\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Reply Buttons", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/buttons", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "buttons" ] }, "description": "Sends clickable buttons (up to 3). Each object in the `buttons` array becomes a different button type depending on the field used:\n\n• `text` + `id` → quick reply button (the contact taps it and the text is sent)\n• `text` + `url` → button that opens an external link\n• `text` + `phone` → call button\n• `text` + `copy` → button that copies a code to the clipboard\n\nWithout `image`, the message is sent with only text + buttons (clean header). With `image`, an image appears at the top. WhatsApp limitation: mixing reply with url/phone/copy in the same message may show an 'Open on your phone' notice.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Como podemos ajudar?\",\n \"buttons\": [\n {\n \"text\": \"Sim\",\n \"id\": \"yes\"\n },\n {\n \"text\": \"Nosso site\",\n \"url\": \"https://exemplo.com\"\n },\n {\n \"text\": \"Ligar\",\n \"phone\": \"+5511999999999\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Options List", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "list" ] }, "description": "Sends a list menu with sections and selectable items. The contact taps the button and chooses an option.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Escolha uma opção:\",\n \"choices\": [\n \"[Produtos]\",\n \"Camiseta|p1|R$ 50\",\n \"Calça|p2|R$ 120\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Poll", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/poll", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "poll" ] }, "description": "Sends a native WhatsApp poll. Contacts vote and the result arrives via webhook.\n\nPoll (type poll): use choices (list of options) and selectableCount (how many the user can select; >1 = multiple choice). WhatsApp accepts 12+ options. Votes arrive through the messages webhook as PollUpdateMessage with the vote field already decrypted (option text); in multiple choice it comes as the comma-separated list of current options, and a removed vote comes empty.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Qual o melhor dia?\",\n \"choices\": [\n \"Segunda\",\n \"Terça\",\n \"Quarta\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send PIX Button", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/pix-button", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "pix-button" ] }, "description": "Sends a native WhatsApp PIX payment button. The contact can copy the key and pay directly.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"pixType\": \"EVP\",\n \"pixKey\": \"123e4567-e89b-12d3-a456-426614174000\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Request Payment", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/request-payment", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "request-payment" ] }, "description": "Sends a payment request with the native WhatsApp \"Review and pay\" button. You must provide at least one payment method: `pixKey`, `boletoCode`, `paymentLink` or `allowCards: true`. Otherwise, the API returns an error.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"amount\": 49.9\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Status / Story", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/status", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "status" ] }, "description": "Publishes a status/story on WhatsApp (text, image, or video). Visible to all contacts for 24 hours.", "body": { "mode": "raw", "raw": "{\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Text", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/send/text", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "send", "text" ] }, "description": "Sends a simple text message to a WhatsApp number. The number must include the country code, for example: 5511999999999.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"text\": \"Olá! Tudo bem?\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Conversations", "item": [ { "name": "Archive Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/archive", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "archive" ] }, "description": "Archives a conversation, hiding it from the main WhatsApp list.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999@s.whatsapp.net\",\n \"archive\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Block / Unblock Contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/block", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "block" ] }, "description": "⚠️ WARNING: Blocks a contact. Do NOT use block: false . it may DISCONNECT the entire instance (known WhatsApp bug). To unblock, use WhatsApp itself.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"block\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Blocked List", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/blocklist", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "blocklist" ] }, "description": "Returns all contacts blocked by the instance." } }, { "name": "Delete Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/delete", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "delete" ] }, "description": "Deletes an entire chat. It can clear only in the app or also in the database.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Search Chats", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/find", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "find" ] }, "description": "Searches chats with advanced filters: by name, label, status, group, and more.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mute Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/mute", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "mute" ] }, "description": "Mutes notifications of a conversation for a period in milliseconds. Example: 86400000 = 24h.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999@s.whatsapp.net\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "View Chat Notes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/notes", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "notes" ] }, "description": "Returns the internal (private) notes associated with a chat.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Edit Chat Notes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/notes/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "notes", "edit" ] }, "description": "Edits the internal notes of a chat. Notes are visible only to you.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reload Notes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/notes/refresh", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "notes", "refresh" ] }, "description": "Reloads the internal WhatsApp notes into the local database.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Pin / Unpin Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/pin", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "pin" ] }, "description": "Pins or unpins a conversation at the top of the WhatsApp chat list.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999@s.whatsapp.net\",\n \"pin\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark Chat as Read", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/read", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "read" ] }, "description": "Marks all unread messages in a conversation as read, resetting the unread counter.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999@s.whatsapp.net\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/delete", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "delete" ] }, "description": "Deletes a sent message for all chat participants. Only messages sent by the instance itself can be deleted.", "body": { "mode": "raw", "raw": "{\n \"id\": \"ABCDEF123456\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Download Media", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/download", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "download" ] }, "description": "Downloads received media (image, video, audio, document) from the message ID. The `id` field must come from the webhook or the `/message/find` endpoint. Note: the transcribe parameter is best-effort and may not return the transcription. For guaranteed audio transcription, use the AI module.", "body": { "mode": "raw", "raw": "{\n \"id\": \"7EB0F01D7244B421048F0706368376E0\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Edit Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "edit" ] }, "description": "Edits the text of a previously sent message. It appears with an edited indicator for the recipient. Only works with messages sent by the instance itself.", "body": { "mode": "raw", "raw": "{\n \"id\": \"ABCDEF123456\",\n \"number\": \"5511999999999\",\n \"text\": \"Texto corrigido...\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Message History", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/find", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "find" ] }, "description": "Returns the instance message history. Filter by `chatid` to fetch messages from a specific conversation. Supports pagination via `limit` and `offset`.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Sync History", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/history-sync", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "history-sync" ] }, "description": "Requests synchronization of older message history for a chat. Messages arrive via webhook/SSE.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark as Read", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/markread", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "markread" ] }, "description": "Marks one or more messages as read. Send an array of IDs.", "body": { "mode": "raw", "raw": "{\n \"id\": [\n \"3EB0538DA65A59F6D8A251\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Typing Indicator...", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/presence", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "presence" ] }, "description": "Shows \"typing...\" or \"recording audio...\" to the contact. The indicator disappears automatically after a few seconds.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"presence\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "React with Emoji", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/react", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "react" ] }, "description": "Sends a reaction (emoji) to an existing message. Send an empty emoji to REMOVE the reaction. The id must be the flattened messageId in the format OWNER:MSGID (e.g. 5511999990000:2A6E2F02CE4125FDBA1B): do not use the Baileys format concatenated with the JID, it will return 404. The confirmation webhook arrives with messageType=ReactionMessage and includes the 'reaction' shortcut in the envelope.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"id\": \"5511999990000:2A6E2F02CE4125FDBA1B\",\n \"emoji\": \"👍\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Disappearing Messages (private chat)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/ephemeral", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "ephemeral" ] }, "description": "Turns disappearing (self-deleting) messages on or off in a private conversation. Applies to the next messages in the conversation. Duration in seconds, following the WhatsApp standard: 0 turns it off, 86400 = 24 hours, 604800 = 7 days, 7776000 = 90 days.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\",\n \"duration\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Contacts and Profile", "item": [ { "name": "Check Number", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/check", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "check" ] }, "description": "Checks whether one or more numbers are registered on WhatsApp. Returns JID, verified name, and status.", "body": { "mode": "raw", "raw": "{\n \"numbers\": \"[\\\"5511999999999\\\", \\\"5521888888888\\\"]\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Contact Details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/details", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "details" ] }, "description": "Returns full details of a contact: name, photo, status, verification, e-commerce.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add Contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/contact/add", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "contact", "add" ] }, "description": "Adds a new contact to the connected WhatsApp address book with name and number.", "body": { "mode": "raw", "raw": "{\n \"phone\": \"5511999999999\",\n \"name\": \"João Silva\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove Contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/contact/remove", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "contact", "remove" ] }, "description": "Removes a contact from the WhatsApp address book.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Contacts (Fast)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "contacts" ] }, "description": "Lists all contacts saved in the WhatsApp address book." } }, { "name": "List Contacts", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/contacts/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "contacts", "list" ] }, "description": "Searches contacts with pagination. Use limit and offset to navigate.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Photo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/profile/image", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "profile", "image" ] }, "description": "Changes your instance profile picture. Send a URL, base64, or \"remove\" to remove it.", "body": { "mode": "raw", "raw": "{\n \"image\": \"https://exemplo.com/logo.jpg\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Name", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/profile/name", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "profile", "name" ] }, "description": "Changes your instance profile name on WhatsApp.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Minha Empresa\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Groups", "item": [ { "name": "Create Community", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/community/create", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "community", "create" ] }, "description": "Creates a WhatsApp Community, a structure that groups multiple groups under a single central announcements channel. The connected number will be the community owner.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Comunidade da Empresa\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Manage Community Groups", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/community/editgroups", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "community", "editgroups" ] }, "description": "Adds or removes groups from an existing community. Use action: add or action: remove with the array of group JIDs.", "body": { "mode": "raw", "raw": "{\n \"community\": \"120363000000000001@g.us\",\n \"action\": \"\",\n \"groups\": [\n \"120363000000000000@g.us\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/create", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "create" ] }, "description": "Creates a new WhatsApp group with the given participants. The connected number is automatically added as an admin. Name: min. 1, max. 100 characters. Maximum of 50 participants.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Meu Time\",\n \"participants\": \"[\\\"5511999990001\\\",\\\"5511999990002\\\"]\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Group Information", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/info", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "info" ] }, "description": "Returns full details of a group: name, description, participants, admins, creation date and settings. Use `getInviteLink: true` to include the invite link in the response.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Info from Invite", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/inviteInfo", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "inviteInfo" ] }, "description": "Gets information about a group from its invite code or link.", "body": { "mode": "raw", "raw": "{\n \"invitecode\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Join Group via Link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/join", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "join" ] }, "description": "Makes the instance join a group using a WhatsApp invite link. Accepts the full URL (https://chat.whatsapp.com/...) or just the code.", "body": { "mode": "raw", "raw": "{\n \"invitecode\": \"https://chat.whatsapp.com/XXXXXXXXXXXXXXXX\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Leave Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/leave", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "leave" ] }, "description": "Removes the connected number from the specified group. This action cannot be undone by the system. Also works for leaving communities.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Groups", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "list" ] }, "description": "Lists all WhatsApp groups. Returns an array with the JID, name and data of each group." } }, { "name": "Search Groups", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "list" ] }, "description": "Lists groups with an option to include participants. Returns an object with a \"groups\" array.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset Invite Code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/resetInviteCode", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "resetInviteCode" ] }, "description": "Generates a new invite code for the group. The previous link will be invalidated.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Admins-Only Mode", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateAnnounce", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateAnnounce" ] }, "description": "Enables or disables the mode in which only admins can send messages. Ideal for one-way communication channels.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"announce\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Group Description", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateDescription", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateDescription" ] }, "description": "Changes the group description. An empty description is not allowed.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"description\": \"Descrição do grupo...\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Group Photo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateImage", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateImage" ] }, "description": "Changes the group image. Send the image URL or \"remove\" to remove it.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"image\": \"https://exemplo.com/foto.jpg ou \\\"remove\\\"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Lock Group Editing", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateLocked", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateLocked" ] }, "description": "When enabled, only admins can change the group name, photo and description.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"locked\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Rename Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateName", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateName" ] }, "description": "Changes the group display name. Min. 1 and max. 25 characters. Requires the connected number to be an admin.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"name\": \"Nome do grupo\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Manage Participants", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateParticipants", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateParticipants" ] }, "description": "Manages group participants. Add, remove, promote or demote.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363000000000000@g.us\",\n \"action\": \"\",\n \"participants\": \"[\\\"5511999990003\\\"]\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Disappearing Messages (group)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/ephemeral", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "ephemeral" ] }, "description": "Turns disappearing messages on or off in the group. Duration in seconds, WhatsApp standard: 0 turns off, 86400 = 24 hours, 604800 = 7 days, 7776000 = 90 days.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363123456789012@g.us\",\n \"duration\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Require Approval to Join", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateJoinApproval", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateJoinApproval" ] }, "description": "Defines whether new members joining the group need admin approval.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363123456789012@g.us\",\n \"IsJoinApprovalRequired\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Who Can Add Members", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/group/updateMemberAddMode", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "group", "updateMemberAddMode" ] }, "description": "Defines who can add new members to the group: only admins or any participant.", "body": { "mode": "raw", "raw": "{\n \"groupjid\": \"120363123456789012@g.us\",\n \"MemberAddMode\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Newsletters and Channels", "item": [ { "name": "Accept Admin Invite", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/admin/accept", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "admin", "accept" ] }, "description": "Accepts an invitation to be an admin of a channel.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Invite Channel Admin", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/admin/invite", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "admin", "invite" ] }, "description": "Invites a number to be an admin of a channel. (Note: may return a GraphQL error depending on the WhatsApp version)", "body": { "mode": "raw", "raw": "{\n \"phone\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove Channel Admin", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/admin/remove", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "admin", "remove" ] }, "description": "Removes an admin from a channel. (Note: may return a GraphQL error depending on the WhatsApp version)", "body": { "mode": "raw", "raw": "{\n \"phone\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Revoke Admin Invite", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/admin/revoke", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "admin", "revoke" ] }, "description": "Revokes a pending admin invite. (Note: may return a GraphQL error depending on the WhatsApp version)", "body": { "mode": "raw", "raw": "{\n \"phone\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create Channel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/create", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "create" ] }, "description": "Creates a new WhatsApp channel (newsletter).", "body": { "mode": "raw", "raw": "{\n \"name\": \"Canal de Promoções\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Channel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/delete", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "delete" ] }, "description": "Deletes a channel that you administer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Channel Description", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/description", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "description" ] }, "description": "Updates the description of a channel. (Note: may return a GraphQL error depending on the WhatsApp version)", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Follow Channel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/follow", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "follow" ] }, "description": "Follows a channel to receive its posts.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Channel Info", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/info", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "info" ] }, "description": "Gets detailed information about a channel.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Find Channel by Link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/link", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "link" ] }, "description": "Looks up channel information by invite link/key.", "body": { "mode": "raw", "raw": "{\n \"key\": \"AbCdEfGhIjKlMn\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Channels", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "list" ] }, "description": "Lists all channels the instance is subscribed to." } }, { "name": "Channel Messages", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/messages", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "messages" ] }, "description": "Fetches messages published in a channel.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Channel Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/messages/delete", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "messages", "delete" ] }, "description": "Deletes a message from a channel that you administer.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Edit Channel Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/messages/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "messages", "edit" ] }, "description": "Edits a recent message in a channel that you administer.", "body": { "mode": "raw", "raw": "{\n \"text\": \"Post atualizado\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mute Channel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/mute", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "mute" ] }, "description": "Mutes notifications from a channel.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Channel Name", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/name", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "name" ] }, "description": "Updates the name of a channel. (Note: may return a GraphQL error depending on the WhatsApp version)", "body": { "mode": "raw", "raw": "{\n \"name\": \"Canal de Promoções VIP\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Transfer Channel Ownership", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/owner/transfer", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "owner", "transfer" ] }, "description": "Transfers channel ownership to another number.", "body": { "mode": "raw", "raw": "{\n \"phone\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Channel Photo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/picture", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "picture" ] }, "description": "Updates the photo of a channel. (Note: may return a GraphQL error depending on the WhatsApp version)", "body": { "mode": "raw", "raw": "{\n \"picture\": \"https://example.com/newsletter.png\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "React to Channel Post", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/reaction", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "reaction" ] }, "description": "Reacts to a channel post.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Search Channels", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/search", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "search" ] }, "description": "Searches public channels by text, country or category.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Channel Settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/settings", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "settings" ] }, "description": "Updates channel settings (e.g. allowed reaction codes). (Note: may return a GraphQL error depending on the WhatsApp version)", "body": { "mode": "raw", "raw": "{\n \"reactionCodes\": \"basic\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Subscribe to Channel Updates", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/subscribe", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "subscribe" ] }, "description": "Subscribes to temporary updates of a channel to receive notifications.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Unfollow", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/unfollow", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "unfollow" ] }, "description": "Unfollows a channel.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Unmute Channel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/unmute", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "unmute" ] }, "description": "Unmutes notifications from a channel.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Channel Updates", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/updates", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "updates" ] }, "description": "Fetches message updates from a channel. (Note: may return a GraphQL error depending on the WhatsApp version)", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark as Viewed", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/newsletter/viewed", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "newsletter", "viewed" ] }, "description": "Marks channel posts as viewed.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Campaigns", "item": [ { "name": "Send Batch Campaign", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/advanced", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "advanced" ] }, "description": "Sends messages in bulk with content individualized per recipient. Each item in the messages array can have a different number and text.", "body": { "mode": "raw", "raw": "{\n \"messages\": \"[{\\\"number\\\":\\\"5511999999999\\\",\\\"text\\\":\\\"Olá!\\\"}]\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Clear Entire Queue", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/clearall", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "clearall" ] }, "description": "Clears the entire message queue, including pending and in-progress messages." } }, { "name": "Clear Completed Campaigns", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/cleardone", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "cleardone" ] }, "description": "Removes from the list all campaigns with completed status within the given folder.", "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"folder_abc123\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Control Campaign", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "edit" ] }, "description": "Controls a bulk sending campaign: pause, resume or cancel.", "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"folder_123\",\n \"action\": \"stop\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Campaigns", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/listfolders", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "listfolders" ] }, "description": "Lists all bulk sending campaigns/folders. Returns a plain array." } }, { "name": "List Campaign Messages", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/listmessages", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "listmessages" ] }, "description": "Returns the messages of a specific campaign with sending status and pagination.", "body": { "mode": "raw", "raw": "{\n \"folder_id\": \"folder_abc123\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send Simple Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sender/simple", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sender", "simple" ] }, "description": "Sends a message to a list of numbers with a random delay between each send. Returns a folder_id for tracking.", "body": { "mode": "raw", "raw": "{\n \"numbers\": \"[\\\"5511999999999\\\",\\\"5511888888888\\\"]\",\n \"type\": \"\",\n \"delayMin\": 1,\n \"delayMax\": 5\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Calls", "item": [ { "name": "Make Call", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/call/make", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "call", "make" ] }, "description": "Starts a voice call to a WhatsApp number. The call rings on the destination but does not establish real voice communication.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject Call", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/call/reject", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "call", "reject" ] }, "description": "Rejects an incoming call.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "WhatsApp Business", "item": [ { "name": "Delete Catalog Product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/catalog/delete", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "catalog", "delete" ] }, "description": "Permanently removes products from the WhatsApp Business catalog. Send an array of IDs in the `productIds` field. Note: a timeout (504) may occur if the IDs are invalid.", "body": { "mode": "raw", "raw": "{\n \"productIds\": \"[\\\"prod_abc123\\\"]\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Hide Catalog Product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/catalog/hide", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "catalog", "hide" ] }, "description": "Hides a product from the public catalog without removing it. ⚠️ May return a 501 error on accounts that do not support this feature. This is a WhatsApp limitation, not an API one.", "body": { "mode": "raw", "raw": "{\n \"id\": \"prod_abc123\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Product Info", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/catalog/info", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "catalog", "info" ] }, "description": "Returns detailed information about a specific catalog product.", "body": { "mode": "raw", "raw": "{\n \"jid\": \"5511999999999@s.whatsapp.net\",\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Product Catalog", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/catalog/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "catalog", "list" ] }, "description": "Returns all products registered in the WhatsApp Business catalog of the given JID.", "body": { "mode": "raw", "raw": "{\n \"jid\": \"5511999999999@s.whatsapp.net\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Catalog Product", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/catalog/show", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "catalog", "show" ] }, "description": "Makes a product visible in the public WhatsApp Business catalog. ⚠️ May return a 501 error on accounts that do not support this feature. This is a WhatsApp limitation, not an API one.", "body": { "mode": "raw", "raw": "{\n \"id\": \"prod_abc123\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Business Categories", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/get/categories", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "get", "categories" ] }, "description": "Returns the list of categories available for the WhatsApp Business profile." } }, { "name": "View Business Profile", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/get/profile", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "get", "profile" ] }, "description": "Returns the WhatsApp Business profile data: description, address, email, website and categories. Send the `jid` with the number (without @s.whatsapp.net). The number is required.", "body": { "mode": "raw", "raw": "{\n \"jid\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Business Profile", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/business/update/profile", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "business", "update", "profile" ] }, "description": "Updates the WhatsApp Business profile data. At least one of the fields `description`, `address` or `email` is required. Note: this endpoint may return 403 forbidden if the instance is not of the Business type.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Settings", "item": [ { "name": "Apply Label to Chat", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/labels", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "labels" ] }, "description": "Manages the labels of a chat. Use `labelids` to set all labels at once, `add_labelid` to add one label, or `remove_labelid` to remove one. Send only one of these fields per request.", "body": { "mode": "raw", "raw": "{\n \"number\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Connect Instance", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/connect", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "connect" ] }, "description": "Connects the instance to WhatsApp. You must scan the QR code after this call.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Disconnect Instance", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/disconnect", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "disconnect" ] }, "description": "Disconnects the instance from WhatsApp. You will need to scan the QR code again to reconnect." } }, { "name": "Presence Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/presence", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "presence" ] }, "description": "Sets whether the instance appears as online or offline to contacts.", "body": { "mode": "raw", "raw": "{\n \"presence\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "View Privacy", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/privacy", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "privacy" ] }, "description": "Returns the account privacy settings: who can add you to groups, see last seen, profile photo and read receipts." } }, { "name": "Change Privacy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/privacy", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "privacy" ] }, "description": "Updates the privacy settings. All fields are optional. Send only what you want to change.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "View Proxy", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/proxy", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "proxy" ] }, "description": "Returns the proxy configuration of the instance." } }, { "name": "Configure Proxy", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/proxy", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "proxy" ] }, "description": "Sets, changes or REMOVES the instance proxy. The canonical field is `mode`: `custom` (your own proxy, requires proxy_url), `internal` (proxy managed by the service) or `none` (removes the proxy, requires confirm_no_proxy=true). To remove the proxy, send mode=none and confirm_no_proxy=true.", "body": { "mode": "raw", "raw": "{\n \"mode\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Restart Instance", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/reset", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "reset" ] }, "description": "Restarts the instance runtime. If the instance is disconnected, you will need to scan the QR code again." } }, { "name": "Instance Info & Status", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/status", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "status" ] }, "description": "Returns full instance data: name, connected phone number, profile photo and current connection status (disconnected, connecting, connected)." } }, { "name": "Configure Delay", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/updateDelaySettings", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "updateDelaySettings" ] }, "description": "Sets the minimum and maximum delay between messages in the queue. Returns the full instance object.", "body": { "mode": "raw", "raw": "{\n \"msg_delay_min\": 0,\n \"msg_delay_max\": 2\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Rename Instance", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/updateInstanceName", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "updateInstanceName" ] }, "description": "Updates the internal name of the instance. Returns the full instance object.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Minha Nova Instância 2024!@#\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create / Edit Label", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/label/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "label", "edit" ] }, "description": "Creates a new label or edits/deletes an existing one. To create, use labelid \"0\" with name and color. To edit, use the real labelid. Color: number from 0 to 19.", "body": { "mode": "raw", "raw": "{\n \"labelid\": \"0\",\n \"name\": \"Cliente VIP\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Labels", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/labels", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "labels" ] }, "description": "Returns all labels created in the instance." } }, { "name": "Reload Labels", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/labels/refresh", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "labels", "refresh" ] }, "description": "Reloads the WhatsApp labels to sync with the local database.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create / Edit Quick Reply", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/quickreply/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "quickreply", "edit" ] }, "description": "Creates or updates a quick reply shortcut. When you type \"/\" followed by the shortcut in WhatsApp, the full message is suggested. To edit, send the `id` field.", "body": { "mode": "raw", "raw": "{\n \"shortCut\": \"bom-dia\",\n \"text\": \"Bom dia! Como posso te ajudar hoje?\",\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Quick Replies", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/quickreply/showall", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "quickreply", "showall" ] }, "description": "Returns all quick replies configured in the instance." } } ] }, { "name": "Webhooks and Events", "item": [ { "name": "Server-Sent Events (SSE)", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/sse", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "sse" ] }, "description": "Opens a Server-Sent Events connection to receive events in real time." } }, { "name": "View Instance Webhook", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "webhook" ] }, "description": "Returns the webhook configuration of the instance. The response is always an array, even with a single webhook." } }, { "name": "Configure Instance Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/webhook", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "webhook" ] }, "description": "Manages the instance webhooks. Supports simple mode (no action) and multi-webhook mode (with action: add/update/delete). To delete, send id + action \"delete\". Events come DISABLED by default. Enable only the ones you will consume (avoids unnecessary traffic). Only enable high-volume events (presence, history) if you will actually handle them.", "body": { "mode": "raw", "raw": "{\n \"url\": \"https://example.com/webhook\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Webhook Errors", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/webhook/errors", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "webhook", "errors" ] }, "description": "Lists the latest webhook delivery errors." } }, { "name": "Recent Webhook Deliveries", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instances/{{id}}/webhook/deliveries?limit=50", "host": [ "{{baseUrl}}" ], "path": [ "instances", "{{id}}", "webhook", "deliveries" ], "query": [ { "key": "limit", "value": "50", "description": "Quantity (max 100)" } ] }, "description": "Lists the latest webhook deliveries of this instance (recent window, for debugging): event, whether it was delivered, HTTP status, latency, attempt number and time. Useful to check whether your endpoint is receiving and responding with 2xx." } } ] }, { "name": "Async Queue", "item": [ { "name": "Clear Async Queue", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/async", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "async" ] }, "description": "Clears the entire async message queue." } }, { "name": "View Async Queue", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/message/async", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "message", "async" ] }, "description": "Queries the queue of pending async messages." } } ] }, { "name": "Chatbot and AI", "item": [ { "name": "Create/Edit AI Agent", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/agent/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "agent", "edit" ] }, "description": "Creates, edits or deletes an AI agent for automatic support. Send an empty id to create; filled to edit; delete=true to delete.", "body": { "mode": "raw", "raw": "{\n \"agent\": {\n \"name\": \"Assistente\",\n \"provider\": \"openai\",\n \"apikey\": \"sk-...\",\n \"model\": \"gpt-4o-mini\",\n \"basePrompt\": \"Voce é um assistente...\",\n \"maxTokens\": 2000,\n \"temperature\": 70,\n \"diversityLevel\": 50,\n \"frequencyPenalty\": 30,\n \"presencePenalty\": 30,\n \"signMessages\": true,\n \"readMessages\": true,\n \"maxMessageLength\": 500,\n \"typingDelay_seconds\": 3,\n \"contextTimeWindow_hours\": 24,\n \"contextMaxMessages\": 50,\n \"contextMinMessages\": 3\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List AI Agents", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/agent/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "agent", "list" ] }, "description": "Lists all AI agents configured in the instance. Returns an empty array if no agent exists." } }, { "name": "Create/Edit API Function", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/function/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "function", "edit" ] }, "description": "Creates, edits or deletes an API function for integration with external services. Send an empty id to create, filled to edit, delete=true to delete.", "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"delete\": \"\",\n \"function\": {\n \"name\": \"minha_funcao\",\n \"description\": \"Descricao da funcao\",\n \"active\": false,\n \"method\": \"GET\",\n \"endpoint\": \"https://api.example.com/endpoint\",\n \"headers\": {},\n \"body\": {},\n \"parameters\": []\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List API Functions", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/function/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "function", "list" ] }, "description": "Lists all configured API functions. Returns an empty array if no function exists." } }, { "name": "Create/Edit Knowledge", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/knowledge/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "knowledge", "edit" ] }, "description": "Creates or edits a knowledge base for AI agents. (Requires an OpenAI API key configured on the instance)", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Knowledge", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/knowledge/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "knowledge", "list" ] }, "description": "Lists the entire knowledge base of the agents. Returns an empty array if no knowledge exists." } }, { "name": "Create/Edit Trigger", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/trigger/edit", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "trigger", "edit" ] }, "description": "Creates, edits or deletes a chatbot trigger. Requires an existing agent (agent_id).", "body": { "mode": "raw", "raw": "{\n \"trigger\": {\n \"active\": true,\n \"type\": \"agent\",\n \"agent_id\": \"id_do_agente\",\n \"ignoreGroups\": true,\n \"priority\": 1,\n \"wordsToStart\": \"ola|oi|iniciar\",\n \"responseDelay_seconds\": 3,\n \"lead_field\": \"\",\n \"lead_operator\": \"\",\n \"lead_value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List Triggers", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/trigger/list", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "trigger", "list" ] }, "description": "Lists all configured chatbot triggers. Returns an empty array if no trigger exists." } } ] }, { "name": "CRM and Leads", "item": [ { "name": "Edit Lead", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chat/editLead", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chat", "editLead" ] }, "description": "Edits the lead data of a contact. The ID must include @s.whatsapp.net.", "body": { "mode": "raw", "raw": "{\n \"id\": \"5511999999999@s.whatsapp.net\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Custom Lead Fields", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/instance/updateFieldsMap", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "instance", "updateFieldsMap" ] }, "description": "Sets the names of the lead fields. Fields are flat (lead_field01, lead_field02, etc).", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Chatwoot Integration", "item": [ { "name": "View Chatwoot Config", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chatwoot/config", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chatwoot", "config" ] }, "description": "Returns the current Chatwoot integration configuration, including connection status." } }, { "name": "Configure Chatwoot", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/chatwoot/config", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "chatwoot", "config" ] }, "description": "Updates the Chatwoot integration configuration. Fields use the chatwoot_ prefix. Integration in beta.", "body": { "mode": "raw", "raw": "{\n \"chatwoot_enabled\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Flows", "item": [ { "name": "List Flows", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/flows", "host": [ "{{baseUrl}}" ], "path": [ "flows" ] }, "description": "Lists all of the user's flows, including status (enabled/disabled) and trigger type." } }, { "name": "Trigger Flow", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/flows/{{flowId}}/trigger", "host": [ "{{baseUrl}}" ], "path": [ "flows", "{{flowId}}", "trigger" ] }, "description": "Triggers a flow for a specific contact. The flow must be enabled and the instance connected. Optional variables are available inside the flow as {variable_name}. When it reaches a webhook block, all collected variables (answers, clicks, contact data) are sent to the configured URL.", "body": { "mode": "raw", "raw": "{\n \"instance_id\": \"inst-456\",\n \"phone\": \"5511999999999\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Meta Tracking", "item": [ { "name": "Register a sale from an ad lead", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/{{{instanceId}}}/tracking/conversion", "host": [ "{{baseUrl}}" ], "path": [ "{{{instanceId}}}", "tracking", "conversion" ] }, "description": "Reports that a lead that came from an ad became a sale. It is what allows Meta to learn who actually buys, instead of optimizing only for who replies to messages. Use it when the payment is confirmed in your system. Calling it twice for the same sale does not duplicate it.", "body": { "mode": "raw", "raw": "{\n \"phone\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }