{
"item": [
{
"name": "Instance",
"description": {
"content": "Conexão (QR code / código de pareamento), status, webhooks e configurações da instância.",
"type": "text/plain"
},
"item": [
{
"name": "QR code (base64)",
"request": {
"name": "QR code (base64)",
"description": {
"content": "Retorna o QR code atual como data URL PNG (`data:image/png;base64,...`). Consulte a cada ~10s enquanto o status for `qr`; cada QR expira em `expires_at` e um novo é gerado automaticamente. `value` é `null` quando não há QR disponível (instância já conectada ou sessão ainda não iniciada). Se a instância ainda não estiver rodando, esta rota inicia a sessão e aguarda alguns segundos pelo primeiro QR. Os QR codes ficam disponíveis por cerca de 13 minutos; se ninguém ler, o pareamento para (`instance_status` `disconnected` com `disconnect_reason: qr_timeout`) e a próxima chamada desta rota recomeça do zero com um QR novo.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"qr-code"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "QR code atual. Quando não há QR o corpo é `{ \"value\": null, \"connected\": true|false }` (sem `expires_at`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"qr-code"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAgAAAAIACAAAAACo...\",\n \"expires_at\": \"2026-08-18T12:01:00.000Z\",\n \"connected\": false\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"qr-code"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "QR code (imagem PNG)",
"request": {
"name": "QR code (imagem PNG)",
"description": {
"content": "Mesmo QR de `GET /qr-code`, entregue como imagem PNG (512×512). Dá para exibir direto em uma tag `![]()
`. Responde `404 not_found` quando não há QR disponível (instância conectada ou sessão ainda não iniciada). Como `GET /qr-code`, recomeça o pareamento se o QR anterior expirou sem ser lido.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"qr-code",
"image"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "image/png"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Imagem PNG do QR code.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"qr-code",
"image"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "image/png"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "image/png"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"qr-code",
"image"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Nenhum QR disponível no momento.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"qr-code",
"image"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"No QR code available for this instance right now\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Código de pareamento por número",
"request": {
"name": "Código de pareamento por número",
"description": {
"content": "Alternativa ao QR. Gera o código para a opção \"Conectar com número de telefone\" do WhatsApp. `phone` é o número que será conectado, com DDI e sem símbolos. A sessão precisa estar em `qr` (aguardando pareamento); caso contrário retorna `409 instance_not_connected`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-code",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Número que será conectado (DDI + DDD + número, só dígitos)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Código a ser digitado no celular.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-code",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Número que será conectado (DDI + DDD + número, só dígitos)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": \"A1B2C3D4\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-code",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Número que será conectado (DDI + DDD + número, só dígitos)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Status da conexão",
"request": {
"name": "Status da conexão",
"description": {
"content": "Consulta o status ao vivo no engine (cai para a última visão conhecida se o engine não responder). `status` é um de `created`, `starting`, `qr`, `connecting`, `connected`, `disconnected`, `logged_out`, `banned`, `stopped`. `smartphone_connected` indica se o celular está alcançável. `error` é `null` quando conectada; caso contrário traz uma frase explicando o motivo.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Status atual da instância. Desconectada: `{ \"connected\": false, \"smartphone_connected\": false, \"status\": \"qr\", \"phone\": null, \"error\": \"You need to scan the QR code\" }`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"connected\": true,\n \"smartphone_connected\": true,\n \"status\": \"connected\",\n \"phone\": \"5511988887777\",\n \"error\": null\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Dados e configuração da instância",
"request": {
"name": "Dados e configuração da instância",
"description": {
"content": "Retorna a instância completa: identificação, `token`, status, número conectado, assinatura, `settings`, `webhooks` e a `api_url` base pronta para uso.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"me"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Instância.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"me"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b\",\n \"name\": \"Atendimento\",\n \"token\": \"3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E\",\n \"status\": \"connected\",\n \"status_reason\": null,\n \"connected\": true,\n \"phone\": \"5511988887777\",\n \"profile_name\": \"Wabox\",\n \"platform\": \"android\",\n \"connected_at\": \"2026-08-18T12:00:30.000Z\",\n \"disconnected_at\": null,\n \"subscription_status\": \"active\",\n \"trial_ends_at\": null,\n \"due_at\": \"2026-09-18T12:00:00.000Z\",\n \"settings\": {\n \"auto_read_message\": false,\n \"auto_read_status\": false,\n \"call_reject_auto\": false,\n \"call_reject_message\": null,\n \"disable_enqueue_when_disconnected\": false,\n \"queue_max_age_hours\": 12,\n \"delay_message_min_ms\": 1000,\n \"delay_message_max_ms\": 3000,\n \"proxy_url\": null,\n \"history_enabled\": true,\n \"always_online\": false\n },\n \"webhooks\": {\n \"use_workspace_webhooks\": false,\n \"received_url\": \"https://example.com/wabox/received\",\n \"delivery_url\": \"https://example.com/wabox/delivery\",\n \"message_status_url\": \"https://example.com/wabox/message-status\",\n \"instance_status_url\": \"https://example.com/wabox/instance-status\",\n \"chat_presence_url\": null,\n \"single_url_enabled\": false,\n \"single_url\": null,\n \"notify_sent_by_me\": false,\n \"notify_status\": false,\n \"ignore_groups\": false,\n \"ignore_private\": false,\n \"ignore_text\": false,\n \"ignore_image\": false,\n \"ignore_video\": false,\n \"ignore_audio\": false,\n \"ignore_document\": false,\n \"ignore_received_callback\": false,\n \"ignore_delivery_callback\": false,\n \"ignore_message_status_callback\": false,\n \"ignore_instance_status_callback\": false,\n \"ignore_chat_presence_callback\": false,\n \"secret\": \"whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0\"\n },\n \"api_url\": \"https://api.wabox.me/instances/8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b/token/3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E\",\n \"created_at\": \"2026-08-18T11:58:00.000Z\",\n \"updated_at\": \"2026-08-18T12:00:30.000Z\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"me"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Dados do celular conectado",
"request": {
"name": "Dados do celular conectado",
"description": {
"content": "Número, JID, nome do perfil, plataforma (`android`, `ios`…) e data da conexão do aparelho vinculado. Retorna `409 instance_not_connected` se a instância não estiver conectada.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"device"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Aparelho conectado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"device"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"phone\": \"5511988887777\",\n \"jid\": \"5511988887777:12@s.whatsapp.net\",\n \"name\": \"Wabox\",\n \"platform\": \"android\",\n \"connected_at\": \"2026-08-18T12:00:30.000Z\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"device"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"device"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Reiniciar a sessão",
"request": {
"name": "Reiniciar a sessão",
"description": {
"content": "Reinicia a sessão da instância no engine sem deslogar o WhatsApp. O engine refaz a conexão com as credenciais salvas. Use quando a instância travar em `disconnected` ou após alterar `settings` de sessão. Numa instância que nunca foi pareada, recomeça o pareamento com um QR novo. `status` é o status logo após o reinício (normalmente `connecting`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"restart"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Sessão reiniciada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"restart"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true,\n \"status\": \"connecting\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"restart"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Desconectar (logout do WhatsApp)",
"request": {
"name": "Desconectar (logout do WhatsApp)",
"description": {
"content": "Desloga a conta do WhatsApp desta instância. O aparelho vinculado é removido e a instância vai para `logged_out`. Para conectar de novo, leia um novo QR code.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"disconnect"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Conta desconectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"disconnect"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"disconnect"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Renomear a instância",
"request": {
"name": "Renomear a instância",
"description": {
"content": "Altera o nome exibido no dashboard (1 a 80 caracteres). Não afeta o perfil do WhatsApp.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"name"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Atendimento\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Nome atualizado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"name"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Atendimento\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"name"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Atendimento\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Consultar URLs, filtros e secret dos webhooks",
"request": {
"name": "Consultar URLs, filtros e secret dos webhooks",
"description": {
"content": "Retorna as URLs de cada tipo de webhook (`*_url`, `null` = desativado) ou uma única para todos (`single_url_enabled` + `single_url`), filtros (`notify_sent_by_me`, `ignore_*`) e o `secret` de assinatura. Com `use_workspace_webhooks: true` (padrão em instâncias novas), a instância usa as URLs, filtros e o `secret` do workspace (painel › Webhooks ou `GET /account/webhooks`) e ignora os campos próprios. `secret` assina toda entrega: header `X-Wabox-Signature: t=,v1=` onde `v1 = HMAC-SHA256(secret, \".\")`. Valide recalculando sobre o corpo bruto da requisição e rejeite timestamps com mais de alguns minutos. `secret` é `null` quando as entregas não são assinadas.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Configuração de webhooks.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"use_workspace_webhooks\": false,\n \"received_url\": \"https://example.com/wabox/received\",\n \"delivery_url\": \"https://example.com/wabox/delivery\",\n \"message_status_url\": \"https://example.com/wabox/message-status\",\n \"instance_status_url\": \"https://example.com/wabox/instance-status\",\n \"chat_presence_url\": null,\n \"single_url_enabled\": false,\n \"single_url\": null,\n \"notify_sent_by_me\": false,\n \"notify_status\": false,\n \"ignore_groups\": false,\n \"ignore_private\": false,\n \"ignore_text\": false,\n \"ignore_image\": false,\n \"ignore_video\": false,\n \"ignore_audio\": false,\n \"ignore_document\": false,\n \"ignore_received_callback\": false,\n \"ignore_delivery_callback\": false,\n \"ignore_message_status_callback\": false,\n \"ignore_instance_status_callback\": false,\n \"ignore_chat_presence_callback\": false,\n \"secret\": \"whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Atualizar webhooks (parcial)",
"request": {
"name": "Atualizar webhooks (parcial)",
"description": {
"content": "Atualiza só os campos enviados; os demais ficam como estão. Envie `null` em uma `*_url` para desativar aquele webhook. URLs precisam ser http(s). `single_url_enabled: true` + `single_url` manda todos os eventos para uma URL só (roteie por `type` ou pelo header `X-Wabox-Event`). Definir uma URL não nula desliga `use_workspace_webhooks` (a instância passa a usar a própria configuração); envie `use_workspace_webhooks: true` para voltar a herdar do workspace. Retorna a configuração completa após a alteração.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"received_url\": \"https://example.com/wabox/received\",\n \"message_status_url\": \"https://example.com/wabox/message-status\",\n \"ignore_groups\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Configuração de webhooks após a alteração.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"received_url\": \"https://example.com/wabox/received\",\n \"message_status_url\": \"https://example.com/wabox/message-status\",\n \"ignore_groups\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"use_workspace_webhooks\": false,\n \"received_url\": \"https://example.com/wabox/received\",\n \"delivery_url\": \"https://example.com/wabox/delivery\",\n \"message_status_url\": \"https://example.com/wabox/message-status\",\n \"instance_status_url\": \"https://example.com/wabox/instance-status\",\n \"chat_presence_url\": null,\n \"single_url_enabled\": false,\n \"single_url\": null,\n \"notify_sent_by_me\": false,\n \"notify_status\": false,\n \"ignore_groups\": true,\n \"ignore_private\": false,\n \"ignore_text\": false,\n \"ignore_image\": false,\n \"ignore_video\": false,\n \"ignore_audio\": false,\n \"ignore_document\": false,\n \"ignore_received_callback\": false,\n \"ignore_delivery_callback\": false,\n \"ignore_message_status_callback\": false,\n \"ignore_instance_status_callback\": false,\n \"ignore_chat_presence_callback\": false,\n \"secret\": \"whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"received_url\": \"https://example.com/wabox/received\",\n \"message_status_url\": \"https://example.com/wabox/message-status\",\n \"ignore_groups\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Rotacionar o secret dos webhooks",
"request": {
"name": "Rotacionar o secret dos webhooks",
"description": {
"content": "Gera um novo `secret` de assinatura e passa a usá-lo imediatamente. Entregas já enfileiradas mantêm o secret anterior nas retentativas restantes.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks",
"secret"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Novo secret.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks",
"secret"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"secret\": \"whsec_0a1b2c3d4e5f60718293a4b5c6d7e8f9\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks",
"secret"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Definir a URL de um webhook",
"request": {
"name": "Definir a URL de um webhook",
"description": {
"content": "`type` é `received`, `delivery`, `message_status`, `instance_status` ou `chat_presence`. Body: `{ \"value\": \"https://...\" }` (`null` para desativar). Retorna a configuração completa de webhooks.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks",
":type"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "received",
"key": "type",
"description": "(Required) Tipo do webhook."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"https://example.com/wabox/received\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Configuração de webhooks após a alteração.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks",
":type"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "received",
"key": "type",
"description": "(Required) Tipo do webhook."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"https://example.com/wabox/received\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"use_workspace_webhooks\": false,\n \"received_url\": \"https://example.com/wabox/received\",\n \"delivery_url\": \"https://example.com/wabox/delivery\",\n \"message_status_url\": \"https://example.com/wabox/message-status\",\n \"instance_status_url\": \"https://example.com/wabox/instance-status\",\n \"chat_presence_url\": null,\n \"single_url_enabled\": false,\n \"single_url\": null,\n \"notify_sent_by_me\": false,\n \"notify_status\": false,\n \"ignore_groups\": false,\n \"ignore_private\": false,\n \"ignore_text\": false,\n \"ignore_image\": false,\n \"ignore_video\": false,\n \"ignore_audio\": false,\n \"ignore_document\": false,\n \"ignore_received_callback\": false,\n \"ignore_delivery_callback\": false,\n \"ignore_message_status_callback\": false,\n \"ignore_instance_status_callback\": false,\n \"ignore_chat_presence_callback\": false,\n \"secret\": \"whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"webhooks",
":type"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "received",
"key": "type",
"description": "(Required) Tipo do webhook."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"https://example.com/wabox/received\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Configurações da instância",
"request": {
"name": "Configurações da instância",
"description": {
"content": "`auto_read_message` e `auto_read_status` marcam mensagens e status como lidos automaticamente. `call_reject_auto` e `call_reject_message` rejeitam chamadas e respondem com um texto. `disable_enqueue_when_disconnected` recusa envios (`409 queue_disabled_while_disconnected`) em vez de enfileirar enquanto a instância está desconectada. `queue_max_age_hours` é a validade das mensagens na fila (1–168 h, padrão 12); as que passam disso saem da fila sem envio e geram `delivery` com `error_code: queue_expired`. `delay_message_min_ms` e `delay_message_max_ms` definem o intervalo aleatório entre envios (anti-ban). `proxy_url` é o proxy usado pela sessão. `always_online` deixa o número online enquanto conectado, o que o WhatsApp exige para mandar a presença dos contatos (`GET /contacts/{phone}/presence`); com o número online, o celular costuma deixar de receber notificações.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"settings"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Configurações atuais.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"settings"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"auto_read_message\": false,\n \"auto_read_status\": false,\n \"call_reject_auto\": false,\n \"call_reject_message\": null,\n \"disable_enqueue_when_disconnected\": false,\n \"queue_max_age_hours\": 12,\n \"delay_message_min_ms\": 1000,\n \"delay_message_max_ms\": 3000,\n \"proxy_url\": null,\n \"history_enabled\": true,\n \"always_online\": false\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"settings"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Atualizar configurações (parcial)",
"request": {
"name": "Atualizar configurações (parcial)",
"description": {
"content": "Atualiza só os campos enviados e retorna as configurações completas. `delay_message_min_ms` não pode ser maior que `delay_message_max_ms` (`409 conflict`). Configurações de sessão (`auto_read_*`, `call_reject_*`, `proxy_url`, `always_online`) só passam a valer após um `restart`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"settings"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"auto_read_message\": true,\n \"delay_message_min_ms\": 2000,\n \"delay_message_max_ms\": 5000\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Configurações após a alteração.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"settings"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"auto_read_message\": true,\n \"delay_message_min_ms\": 2000,\n \"delay_message_max_ms\": 5000\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"auto_read_message\": true,\n \"auto_read_status\": false,\n \"call_reject_auto\": false,\n \"call_reject_message\": null,\n \"disable_enqueue_when_disconnected\": false,\n \"queue_max_age_hours\": 12,\n \"delay_message_min_ms\": 2000,\n \"delay_message_max_ms\": 5000,\n \"proxy_url\": null,\n \"history_enabled\": true,\n \"always_online\": false\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"settings"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"auto_read_message\": true,\n \"delay_message_min_ms\": 2000,\n \"delay_message_max_ms\": 5000\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Messages",
"description": {
"content": "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`.",
"type": "text/plain"
},
"item": [
{
"name": "Enviar texto",
"request": {
"name": "Enviar texto",
"description": {
"content": "Suporta resposta (`reply_to_message_id`), menções e edição (`edit_message_id`). Formatação do texto: `*negrito*`, `_itálico_`, `~riscado~` e `` ```mono``` ``.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.\n\nRitmo de envio (anti-ban). Cada mensagem espera um atraso aleatório antes de sair (configurações da instância `delay_message_min_ms`/`delay_message_max_ms`, padrão 1–3 s; defina os dois como 0 para desativar), contado a partir do fim da mensagem anterior da mesma instância quando ainda houver uma em andamento. `delay_message` (segundos, 0–15) substitui esse atraso só para esta mensagem e `delay_typing` (segundos, 0–15) mostra \"digitando…\" por esse tempo antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-text"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Olá! Seu pedido *#1234* foi confirmado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-text"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Olá! Seu pedido *#1234* foi confirmado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-text"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Olá! Seu pedido *#1234* foi confirmado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-text"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Olá! Seu pedido *#1234* foi confirmado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-text"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Olá! Seu pedido *#1234* foi confirmado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-text"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Olá! Seu pedido *#1234* foi confirmado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar texto com preview de link",
"request": {
"name": "Enviar texto com preview de link",
"description": {
"content": "Você define título, descrição e imagem do preview; a API não faz scraping da página. A URL é acrescentada ao texto quando ele ainda não a contém.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Veja as novidades no nosso site: https://wabox.me\",\n \"url\": \"https://wabox.me\",\n \"title\": \"Wabox — API de WhatsApp\",\n \"description\": \"Envie e receba mensagens via REST e webhooks.\",\n \"image\": \"https://wabox.me/og.png\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Veja as novidades no nosso site: https://wabox.me\",\n \"url\": \"https://wabox.me\",\n \"title\": \"Wabox — API de WhatsApp\",\n \"description\": \"Envie e receba mensagens via REST e webhooks.\",\n \"image\": \"https://wabox.me/og.png\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Veja as novidades no nosso site: https://wabox.me\",\n \"url\": \"https://wabox.me\",\n \"title\": \"Wabox — API de WhatsApp\",\n \"description\": \"Envie e receba mensagens via REST e webhooks.\",\n \"image\": \"https://wabox.me/og.png\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Veja as novidades no nosso site: https://wabox.me\",\n \"url\": \"https://wabox.me\",\n \"title\": \"Wabox — API de WhatsApp\",\n \"description\": \"Envie e receba mensagens via REST e webhooks.\",\n \"image\": \"https://wabox.me/og.png\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Veja as novidades no nosso site: https://wabox.me\",\n \"url\": \"https://wabox.me\",\n \"title\": \"Wabox — API de WhatsApp\",\n \"description\": \"Envie e receba mensagens via REST e webhooks.\",\n \"image\": \"https://wabox.me/og.png\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Veja as novidades no nosso site: https://wabox.me\",\n \"url\": \"https://wabox.me\",\n \"title\": \"Wabox — API de WhatsApp\",\n \"description\": \"Envie e receba mensagens via REST e webhooks.\",\n \"image\": \"https://wabox.me/og.png\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar imagem",
"request": {
"name": "Enviar imagem",
"description": {
"content": "A mídia pode ser uma URL http(s) (baixada pelo engine), uma `data:` URL ou base64 puro. Use `mime_type`/`file_name` quando o tipo não puder ser inferido. Limites: 16 MB para imagens/áudios/vídeos/stickers, 100 MB para documentos (arquivos maiores falham no webhook `delivery` com `media_invalid`). Envios de mídia são processados um por vez por instância. `edit_message_id` substitui a legenda de uma imagem que esta instância enviou.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-image"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"caption\": \"Chegou o novo modelo!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-image"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"caption\": \"Chegou o novo modelo!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-image"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"caption\": \"Chegou o novo modelo!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-image"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"caption\": \"Chegou o novo modelo!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-image"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"caption\": \"Chegou o novo modelo!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-image"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"image\": \"https://exemplo.com/produto.jpg\",\n \"caption\": \"Chegou o novo modelo!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar áudio / mensagem de voz",
"request": {
"name": "Enviar áudio / mensagem de voz",
"description": {
"content": "A mídia pode ser uma URL http(s) (baixada pelo engine), uma `data:` URL ou base64 puro. Use `mime_type`/`file_name` quando o tipo não puder ser inferido. Limites: 16 MB para imagens/áudios/vídeos/stickers, 100 MB para documentos (arquivos maiores falham no webhook `delivery` com `media_invalid`). Envios de mídia são processados um por vez por instância. `ptt: true` (padrão) envia como mensagem de voz, convertida para Opus/OGG com waveform quando o engine tem ffmpeg. `delay_typing` mostra \"gravando áudio…\".\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-audio"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"audio\": \"https://exemplo.com/audio.mp3\",\n \"delay_typing\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-audio"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"audio\": \"https://exemplo.com/audio.mp3\",\n \"delay_typing\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-audio"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"audio\": \"https://exemplo.com/audio.mp3\",\n \"delay_typing\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-audio"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"audio\": \"https://exemplo.com/audio.mp3\",\n \"delay_typing\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-audio"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"audio\": \"https://exemplo.com/audio.mp3\",\n \"delay_typing\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-audio"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"audio\": \"https://exemplo.com/audio.mp3\",\n \"delay_typing\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar vídeo",
"request": {
"name": "Enviar vídeo",
"description": {
"content": "A mídia pode ser uma URL http(s) (baixada pelo engine), uma `data:` URL ou base64 puro. Use `mime_type`/`file_name` quando o tipo não puder ser inferido. Limites: 16 MB para imagens/áudios/vídeos/stickers, 100 MB para documentos (arquivos maiores falham no webhook `delivery` com `media_invalid`). Envios de mídia são processados um por vez por instância.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-video"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"video\": \"https://exemplo.com/demo.mp4\",\n \"caption\": \"Veja como funciona\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-video"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"video\": \"https://exemplo.com/demo.mp4\",\n \"caption\": \"Veja como funciona\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-video"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"video\": \"https://exemplo.com/demo.mp4\",\n \"caption\": \"Veja como funciona\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-video"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"video\": \"https://exemplo.com/demo.mp4\",\n \"caption\": \"Veja como funciona\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-video"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"video\": \"https://exemplo.com/demo.mp4\",\n \"caption\": \"Veja como funciona\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-video"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"video\": \"https://exemplo.com/demo.mp4\",\n \"caption\": \"Veja como funciona\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar vídeo redondo (PTV)",
"request": {
"name": "Enviar vídeo redondo (PTV)",
"description": {
"content": "A mídia pode ser uma URL http(s) (baixada pelo engine), uma `data:` URL ou base64 puro. Use `mime_type`/`file_name` quando o tipo não puder ser inferido. Limites: 16 MB para imagens/áudios/vídeos/stickers, 100 MB para documentos (arquivos maiores falham no webhook `delivery` com `media_invalid`). Envios de mídia são processados um por vez por instância.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-ptv"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"ptv\": \"https://exemplo.com/recado.mp4\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-ptv"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"ptv\": \"https://exemplo.com/recado.mp4\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-ptv"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"ptv\": \"https://exemplo.com/recado.mp4\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-ptv"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"ptv\": \"https://exemplo.com/recado.mp4\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-ptv"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"ptv\": \"https://exemplo.com/recado.mp4\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-ptv"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"ptv\": \"https://exemplo.com/recado.mp4\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar GIF (MP4 com reprodução de GIF)",
"request": {
"name": "Enviar GIF (MP4 com reprodução de GIF)",
"description": {
"content": "A mídia pode ser uma URL http(s) (baixada pelo engine), uma `data:` URL ou base64 puro. Use `mime_type`/`file_name` quando o tipo não puder ser inferido. Limites: 16 MB para imagens/áudios/vídeos/stickers, 100 MB para documentos (arquivos maiores falham no webhook `delivery` com `media_invalid`). Envios de mídia são processados um por vez por instância. Envie um MP4. Quando o engine tem ffmpeg, ele converte arquivos .gif de verdade.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-gif"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"gif\": \"https://exemplo.com/festa.mp4\",\n \"caption\": \"Parabéns!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-gif"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"gif\": \"https://exemplo.com/festa.mp4\",\n \"caption\": \"Parabéns!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-gif"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"gif\": \"https://exemplo.com/festa.mp4\",\n \"caption\": \"Parabéns!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-gif"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"gif\": \"https://exemplo.com/festa.mp4\",\n \"caption\": \"Parabéns!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-gif"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"gif\": \"https://exemplo.com/festa.mp4\",\n \"caption\": \"Parabéns!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-gif"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"gif\": \"https://exemplo.com/festa.mp4\",\n \"caption\": \"Parabéns!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar documento",
"request": {
"name": "Enviar documento",
"description": {
"content": "A mídia pode ser uma URL http(s) (baixada pelo engine), uma `data:` URL ou base64 puro. Use `mime_type`/`file_name` quando o tipo não puder ser inferido. Limites: 16 MB para imagens/áudios/vídeos/stickers, 100 MB para documentos (arquivos maiores falham no webhook `delivery` com `media_invalid`). Envios de mídia são processados um por vez por instância. A extensão pode ir no path (`send-document/pdf`, no estilo z-api) ou no body (`extension`); ela define o nome do arquivo/MIME type quando faltarem (`document.pdf` se `file_name` não for enviado). Extensão inválida (fora de `[a-z0-9]{1,10}`) responde 400 `invalid_request`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-document"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "string",
"key": "extension",
"description": "(Required) Extensão do arquivo (`pdf`, `xlsx`…). Alternativa ao campo `extension` do body."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"document\": \"https://exemplo.com/fatura-1234.pdf\",\n \"file_name\": \"fatura-1234.pdf\",\n \"caption\": \"Sua fatura de setembro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-document"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "string",
"key": "extension",
"description": "(Required) Extensão do arquivo (`pdf`, `xlsx`…). Alternativa ao campo `extension` do body."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"document\": \"https://exemplo.com/fatura-1234.pdf\",\n \"file_name\": \"fatura-1234.pdf\",\n \"caption\": \"Sua fatura de setembro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-document"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "string",
"key": "extension",
"description": "(Required) Extensão do arquivo (`pdf`, `xlsx`…). Alternativa ao campo `extension` do body."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"document\": \"https://exemplo.com/fatura-1234.pdf\",\n \"file_name\": \"fatura-1234.pdf\",\n \"caption\": \"Sua fatura de setembro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-document"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "string",
"key": "extension",
"description": "(Required) Extensão do arquivo (`pdf`, `xlsx`…). Alternativa ao campo `extension` do body."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"document\": \"https://exemplo.com/fatura-1234.pdf\",\n \"file_name\": \"fatura-1234.pdf\",\n \"caption\": \"Sua fatura de setembro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-document"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "string",
"key": "extension",
"description": "(Required) Extensão do arquivo (`pdf`, `xlsx`…). Alternativa ao campo `extension` do body."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"document\": \"https://exemplo.com/fatura-1234.pdf\",\n \"file_name\": \"fatura-1234.pdf\",\n \"caption\": \"Sua fatura de setembro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-document"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "string",
"key": "extension",
"description": "(Required) Extensão do arquivo (`pdf`, `xlsx`…). Alternativa ao campo `extension` do body."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"document\": \"https://exemplo.com/fatura-1234.pdf\",\n \"file_name\": \"fatura-1234.pdf\",\n \"caption\": \"Sua fatura de setembro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar sticker",
"request": {
"name": "Enviar sticker",
"description": {
"content": "A mídia pode ser uma URL http(s) (baixada pelo engine), uma `data:` URL ou base64 puro. Use `mime_type`/`file_name` quando o tipo não puder ser inferido. Limites: 16 MB para imagens/áudios/vídeos/stickers, 100 MB para documentos (arquivos maiores falham no webhook `delivery` com `media_invalid`). Envios de mídia são processados um por vez por instância. O engine envia WebP como está e, quando tem ffmpeg, converte PNG/JPEG/GIF para WebP 512×512.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-sticker"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"sticker\": \"https://exemplo.com/sticker.webp\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-sticker"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"sticker\": \"https://exemplo.com/sticker.webp\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-sticker"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"sticker\": \"https://exemplo.com/sticker.webp\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-sticker"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"sticker\": \"https://exemplo.com/sticker.webp\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-sticker"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"sticker\": \"https://exemplo.com/sticker.webp\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-sticker"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"sticker\": \"https://exemplo.com/sticker.webp\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar localização",
"request": {
"name": "Enviar localização",
"description": {
"content": "A mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-location"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308,\n \"name\": \"Wabox\",\n \"address\": \"Praça da Sé, São Paulo - SP\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-location"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308,\n \"name\": \"Wabox\",\n \"address\": \"Praça da Sé, São Paulo - SP\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-location"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308,\n \"name\": \"Wabox\",\n \"address\": \"Praça da Sé, São Paulo - SP\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-location"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308,\n \"name\": \"Wabox\",\n \"address\": \"Praça da Sé, São Paulo - SP\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-location"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308,\n \"name\": \"Wabox\",\n \"address\": \"Praça da Sé, São Paulo - SP\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-location"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308,\n \"name\": \"Wabox\",\n \"address\": \"Praça da Sé, São Paulo - SP\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar cartão de contato",
"request": {
"name": "Enviar cartão de contato",
"description": {
"content": "Envia um único vCard. Para vários contatos na mesma mensagem use `send-contacts`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contact"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contact_name\": \"Maria Silva\",\n \"contact_phone\": \"5511977776666\",\n \"contact_description\": \"Atendimento Wabox\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contact"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contact_name\": \"Maria Silva\",\n \"contact_phone\": \"5511977776666\",\n \"contact_description\": \"Atendimento Wabox\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contact"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contact_name\": \"Maria Silva\",\n \"contact_phone\": \"5511977776666\",\n \"contact_description\": \"Atendimento Wabox\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contact"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contact_name\": \"Maria Silva\",\n \"contact_phone\": \"5511977776666\",\n \"contact_description\": \"Atendimento Wabox\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contact"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contact_name\": \"Maria Silva\",\n \"contact_phone\": \"5511977776666\",\n \"contact_description\": \"Atendimento Wabox\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contact"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contact_name\": \"Maria Silva\",\n \"contact_phone\": \"5511977776666\",\n \"contact_description\": \"Atendimento Wabox\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar vários contatos em uma mensagem",
"request": {
"name": "Enviar vários contatos em uma mensagem",
"description": {
"content": "Até 50 cartões na mesma mensagem.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contacts\": [\n {\n \"name\": \"Maria Silva\",\n \"phone\": \"5511977776666\",\n \"description\": \"Atendimento\"\n },\n {\n \"name\": \"João Souza\",\n \"phone\": \"5511966665555\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contacts\": [\n {\n \"name\": \"Maria Silva\",\n \"phone\": \"5511977776666\",\n \"description\": \"Atendimento\"\n },\n {\n \"name\": \"João Souza\",\n \"phone\": \"5511966665555\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contacts\": [\n {\n \"name\": \"Maria Silva\",\n \"phone\": \"5511977776666\",\n \"description\": \"Atendimento\"\n },\n {\n \"name\": \"João Souza\",\n \"phone\": \"5511966665555\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contacts\": [\n {\n \"name\": \"Maria Silva\",\n \"phone\": \"5511977776666\",\n \"description\": \"Atendimento\"\n },\n {\n \"name\": \"João Souza\",\n \"phone\": \"5511966665555\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contacts\": [\n {\n \"name\": \"Maria Silva\",\n \"phone\": \"5511977776666\",\n \"description\": \"Atendimento\"\n },\n {\n \"name\": \"João Souza\",\n \"phone\": \"5511966665555\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"contacts\": [\n {\n \"name\": \"Maria Silva\",\n \"phone\": \"5511977776666\",\n \"description\": \"Atendimento\"\n },\n {\n \"name\": \"João Souza\",\n \"phone\": \"5511966665555\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Reagir a uma mensagem",
"request": {
"name": "Reagir a uma mensagem",
"description": {
"content": "Retorna o id da mensagem que recebeu a reação. Em grupos, informe `participant` (quem enviou a mensagem) e `from_me` quando o engine não conhecer a mensagem. A mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Ação enfileirada. `message_id`/`id` é o id da mensagem referenciada; o resultado chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Remover sua reação de uma mensagem",
"request": {
"name": "Remover sua reação de uma mensagem",
"description": {
"content": "Envia uma reação vazia para a mensagem informada. A mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"remove-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Ação enfileirada. `message_id`/`id` é o id da mensagem referenciada; o resultado chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"remove-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"remove-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"remove-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"remove-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"remove-reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Encaminhar mensagem",
"request": {
"name": "Encaminhar mensagem",
"description": {
"content": "Só é possível encaminhar mensagens que esta instância enviou ou recebeu recentemente (o engine mantém um histórico limitado em memória; nada é armazenado em repouso). Caso contrário o webhook `delivery` reporta `message_not_found`. `from_phone` indica o chat de origem quando for diferente do destino. A mensagem encaminhada recebe um id novo, que é o `message_id` retornado.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"forward-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0F1A2B3C4D5E6F7A8\",\n \"from_phone\": \"5511977776666\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"forward-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0F1A2B3C4D5E6F7A8\",\n \"from_phone\": \"5511977776666\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"forward-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0F1A2B3C4D5E6F7A8\",\n \"from_phone\": \"5511977776666\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"forward-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0F1A2B3C4D5E6F7A8\",\n \"from_phone\": \"5511977776666\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"forward-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0F1A2B3C4D5E6F7A8\",\n \"from_phone\": \"5511977776666\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"forward-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0F1A2B3C4D5E6F7A8\",\n \"from_phone\": \"5511977776666\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Fixar ou desafixar mensagem",
"request": {
"name": "Fixar ou desafixar mensagem",
"description": {
"content": "`pin: false` desafixa. `duration_seconds` aceita 86400 (24 h), 604800 (7 dias, padrão) ou 2592000 (30 dias). Não aceita `delay_message`/`delay_typing`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"pin-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Ação enfileirada. `message_id`/`id` é o id da mensagem referenciada; o resultado chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"pin-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"pin-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"pin-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"pin-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"pin-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Apagar mensagem para todos",
"request": {
"name": "Apagar mensagem para todos",
"description": {
"content": "Parâmetros via query string (ou body JSON): `phone`, `message_id`, `owner` opcional (padrão true; `false` apaga a mensagem de outra pessoa quando você é admin do grupo) e `participant`. Não aceita `delay_message`/`delay_typing`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Ação enfileirada. `message_id`/`id` é o id da mensagem referenciada; o resultado chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar enquete",
"request": {
"name": "Enviar enquete",
"description": {
"content": "De 2 a 12 opções. `poll_max_options` define quantas opções podem ser marcadas (0 = sem limite; padrão 1). Os votos chegam no webhook `received`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"question\": \"Qual horário prefere para a reunião?\",\n \"options\": [\n \"09:00\",\n \"14:00\",\n \"17:00\"\n ],\n \"poll_max_options\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada. O resultado do envio chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"question\": \"Qual horário prefere para a reunião?\",\n \"options\": [\n \"09:00\",\n \"14:00\",\n \"17:00\"\n ],\n \"poll_max_options\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"question\": \"Qual horário prefere para a reunião?\",\n \"options\": [\n \"09:00\",\n \"14:00\",\n \"17:00\"\n ],\n \"poll_max_options\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"question\": \"Qual horário prefere para a reunião?\",\n \"options\": [\n \"09:00\",\n \"14:00\",\n \"17:00\"\n ],\n \"poll_max_options\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"question\": \"Qual horário prefere para a reunião?\",\n \"options\": [\n \"09:00\",\n \"14:00\",\n \"17:00\"\n ],\n \"poll_max_options\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"question\": \"Qual horário prefere para a reunião?\",\n \"options\": [\n \"09:00\",\n \"14:00\",\n \"17:00\"\n ],\n \"poll_max_options\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Votar em uma enquete",
"request": {
"name": "Votar em uma enquete",
"description": {
"content": "Só é possível votar em enquetes que esta instância enviou ou recebeu. `options` recebe os nomes das opções; um array vazio limpa o voto. Não aceita `delay_message`/`delay_typing`. A mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll-vote"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"poll_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"options\": [\n \"14:00\"\n ],\n \"participant\": \"5511977776666\",\n \"from_me\": false\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Voto enfileirado. `message_id`/`id` é o id da mensagem de voto (não o da enquete); o resultado chega no webhook `delivery`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll-vote"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"poll_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"options\": [\n \"14:00\"\n ],\n \"participant\": \"5511977776666\",\n \"from_me\": false\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll-vote"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"poll_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"options\": [\n \"14:00\"\n ],\n \"participant\": \"5511977776666\",\n \"from_me\": false\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll-vote"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"poll_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"options\": [\n \"14:00\"\n ],\n \"participant\": \"5511977776666\",\n \"from_me\": false\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância desconectada com a configuração `disable_enqueue_when_disconnected` ativa (`queue_disabled_while_disconnected`), ou `custom_message_id` já usado por uma mensagem na fila ou enviada desta instância (`duplicate_message_id`, com `details.wabox_id` do envio existente). Nas ações imediatas (`read-message`, `send-presence`), instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll-vote"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"poll_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"options\": [\n \"14:00\"\n ],\n \"participant\": \"5511977776666\",\n \"from_me\": false\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_disabled_while_disconnected\",\n \"message\": \"Instance is disconnected and enqueueing while disconnected is disabled\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-poll-vote"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"poll_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"options\": [\n \"14:00\"\n ],\n \"participant\": \"5511977776666\",\n \"from_me\": false\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Marcar mensagens como lidas (ticks azuis)",
"request": {
"name": "Marcar mensagens como lidas (ticks azuis)",
"description": {
"content": "Ação imediata: exige a instância conectada e não passa pela fila (responde 409 `instance_not_connected` se estiver offline). Informe `message_id` ou `message_ids` (até 100) e, em grupos, o `participant` que as enviou.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"read-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Recibos de leitura enviados. `read` lista os ids marcados.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"read-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true,\n \"read\": [\n \"3EB0A9C6D2F1E4B5A7C8\"\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"read-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"read-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"read-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"read-message"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Mostrar digitando / gravando / online",
"request": {
"name": "Mostrar digitando / gravando / online",
"description": {
"content": "Ação imediata: exige a instância conectada e não passa pela fila (responde 409 `instance_not_connected` se estiver offline). `composing`/`recording`/`paused` precisam de `phone` (sem ele, 400 `invalid_request`); `available`/`unavailable` são globais. `status` não diferencia maiúsculas de minúsculas. O WhatsApp limpa o \"digitando…\" depois de alguns segundos, então repita a chamada para manter.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"status\": \"composing\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Presença enviada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"status\": \"composing\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"status\": \"composing\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"status\": \"composing\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (`instance_not_connected`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"status\": \"composing\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Fila cheia: a instância está desconectada e já há 1000 mensagens aguardando (`queue_full`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"status\": \"composing\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"queue_full\",\n \"message\": \"Queue is full (1000 messages waiting)\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Interactive",
"description": {
"content": "Botões, listas, carrossel, PIX, eventos de calendário, status (stories) e convite de canal. Best effort. Renderizam no celular, mas o WhatsApp Web/Desktop não exibe botões, listas nem carrossel.",
"type": "text/plain"
},
"item": [
{
"name": "Enviar mensagem com botões",
"request": {
"name": "Enviar mensagem com botões",
"description": {
"content": "Até 10 botões em `buttons[]`, de quatro tipos: `{ type: \"reply\", id, label }` (resposta rápida; o `id` volta no webhook `buttons_response`), `{ type: \"url\", label, url }` (abre um link), `{ type: \"call\", label, phone }` (liga para o número) e `{ type: \"copy\", label, code }` (copia `code` para a área de transferência). `label` tem até 60 caracteres. Se `type` for omitido, a API o infere pelos outros campos (com `url` vira url, com `phone` vira call, com `code` vira copy, senão reply; um botão reply sem `id` usa o `label` como id). Esse formato é compatível com o do z-api. Opcionais: `image` de cabeçalho (URL, data URL ou base64), `title` e `footer`. `send-button-actions` é um alias da mesma rota.\n\n**Best effort.** Mensagens interativas não são um recurso oficial para contas comuns do WhatsApp. Elas são entregues como mensagens \"native flow\", e a renderização depende do app e da plataforma de quem recebe. Celulares (Android/iOS) exibem normalmente, mas o **WhatsApp Web e o WhatsApp Desktop não exibem** botões, lista nem carrossel. Eles mostram o placeholder \"mensagem de visualização única\" e a pessoa precisa abrir no celular. Outras APIs não-oficiais se comportam do mesmo jeito, e não há contorno conhecido, já que o conteúdo é cifrado igual para todos os dispositivos. Em versões antigas do app a mensagem pode chegar como texto simples. Botões `reply` voltam como webhook `buttons_response`; a opção escolhida em uma lista, como `list_response`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"title\": \"Pedido #4821\",\n \"message\": \"Seu pedido saiu para entrega. O que deseja fazer?\",\n \"footer\": \"Wabox Store\",\n \"image\": \"https://example.com/pedidos/4821.jpg\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"confirmar_recebimento\",\n \"label\": \"Confirmar recebimento\"\n },\n {\n \"type\": \"url\",\n \"label\": \"Rastrear entrega\",\n \"url\": \"https://example.com/rastreio/4821\"\n },\n {\n \"type\": \"call\",\n \"label\": \"Falar com a loja\",\n \"phone\": \"5511977776666\"\n },\n {\n \"type\": \"copy\",\n \"label\": \"Copiar cupom\",\n \"code\": \"FRETE10\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"title\": \"Pedido #4821\",\n \"message\": \"Seu pedido saiu para entrega. O que deseja fazer?\",\n \"footer\": \"Wabox Store\",\n \"image\": \"https://example.com/pedidos/4821.jpg\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"confirmar_recebimento\",\n \"label\": \"Confirmar recebimento\"\n },\n {\n \"type\": \"url\",\n \"label\": \"Rastrear entrega\",\n \"url\": \"https://example.com/rastreio/4821\"\n },\n {\n \"type\": \"call\",\n \"label\": \"Falar com a loja\",\n \"phone\": \"5511977776666\"\n },\n {\n \"type\": \"copy\",\n \"label\": \"Copiar cupom\",\n \"code\": \"FRETE10\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"title\": \"Pedido #4821\",\n \"message\": \"Seu pedido saiu para entrega. O que deseja fazer?\",\n \"footer\": \"Wabox Store\",\n \"image\": \"https://example.com/pedidos/4821.jpg\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"confirmar_recebimento\",\n \"label\": \"Confirmar recebimento\"\n },\n {\n \"type\": \"url\",\n \"label\": \"Rastrear entrega\",\n \"url\": \"https://example.com/rastreio/4821\"\n },\n {\n \"type\": \"call\",\n \"label\": \"Falar com a loja\",\n \"phone\": \"5511977776666\"\n },\n {\n \"type\": \"copy\",\n \"label\": \"Copiar cupom\",\n \"code\": \"FRETE10\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"title\": \"Pedido #4821\",\n \"message\": \"Seu pedido saiu para entrega. O que deseja fazer?\",\n \"footer\": \"Wabox Store\",\n \"image\": \"https://example.com/pedidos/4821.jpg\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"confirmar_recebimento\",\n \"label\": \"Confirmar recebimento\"\n },\n {\n \"type\": \"url\",\n \"label\": \"Rastrear entrega\",\n \"url\": \"https://example.com/rastreio/4821\"\n },\n {\n \"type\": \"call\",\n \"label\": \"Falar com a loja\",\n \"phone\": \"5511977776666\"\n },\n {\n \"type\": \"copy\",\n \"label\": \"Copiar cupom\",\n \"code\": \"FRETE10\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar código OTP com botão \"copiar\"",
"request": {
"name": "Enviar código OTP com botão \"copiar\"",
"description": {
"content": "Atalho para uma mensagem com um único botão `copy` que coloca `code` na área de transferência do destinatário. `button_label` é o texto do botão (padrão `Copiar código`). Aceita `title`, `footer` e os campos de resposta/menção como `send-button-list`.\n\n**Best effort.** Mensagens interativas não são um recurso oficial para contas comuns do WhatsApp. Elas são entregues como mensagens \"native flow\", e a renderização depende do app e da plataforma de quem recebe. Celulares (Android/iOS) exibem normalmente, mas o **WhatsApp Web e o WhatsApp Desktop não exibem** botões, lista nem carrossel. Eles mostram o placeholder \"mensagem de visualização única\" e a pessoa precisa abrir no celular. Outras APIs não-oficiais se comportam do mesmo jeito, e não há contorno conhecido, já que o conteúdo é cifrado igual para todos os dispositivos. Em versões antigas do app a mensagem pode chegar como texto simples. Botões `reply` voltam como webhook `buttons_response`; a opção escolhida em uma lista, como `list_response`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-otp"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Seu código de verificação é *482913*. Ele expira em 5 minutos.\",\n \"code\": \"482913\",\n \"button_label\": \"Copiar código\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-otp"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Seu código de verificação é *482913*. Ele expira em 5 minutos.\",\n \"code\": \"482913\",\n \"button_label\": \"Copiar código\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-otp"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Seu código de verificação é *482913*. Ele expira em 5 minutos.\",\n \"code\": \"482913\",\n \"button_label\": \"Copiar código\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-otp"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Seu código de verificação é *482913*. Ele expira em 5 minutos.\",\n \"code\": \"482913\",\n \"button_label\": \"Copiar código\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar botão de pagamento PIX",
"request": {
"name": "Enviar botão de pagamento PIX",
"description": {
"content": "Envia um card \"copiar chave PIX\" com o `name` do recebedor, a chave (`key`) e o `key_type` (`cpf`, `cnpj`, `phone`, `email` ou `evp` para chave aleatória; aceita maiúsculas). `message` é um texto opcional acima do botão. A chave PIX é estática e não leva o valor, então informe-o no texto.\n\n**Best effort.** Mensagens interativas não são um recurso oficial para contas comuns do WhatsApp. Elas são entregues como mensagens \"native flow\", e a renderização depende do app e da plataforma de quem recebe. Celulares (Android/iOS) exibem normalmente, mas o **WhatsApp Web e o WhatsApp Desktop não exibem** botões, lista nem carrossel. Eles mostram o placeholder \"mensagem de visualização única\" e a pessoa precisa abrir no celular. Outras APIs não-oficiais se comportam do mesmo jeito, e não há contorno conhecido, já que o conteúdo é cifrado igual para todos os dispositivos. Em versões antigas do app a mensagem pode chegar como texto simples. Botões `reply` voltam como webhook `buttons_response`; a opção escolhida em uma lista, como `list_response`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-pix"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"name\": \"Wabox Store LTDA\",\n \"key\": \"12345678000199\",\n \"key_type\": \"cnpj\",\n \"message\": \"Para concluir o pedido #4821, pague R$ 149,90 na chave PIX abaixo.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-pix"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"name\": \"Wabox Store LTDA\",\n \"key\": \"12345678000199\",\n \"key_type\": \"cnpj\",\n \"message\": \"Para concluir o pedido #4821, pague R$ 149,90 na chave PIX abaixo.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-pix"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"name\": \"Wabox Store LTDA\",\n \"key\": \"12345678000199\",\n \"key_type\": \"cnpj\",\n \"message\": \"Para concluir o pedido #4821, pague R$ 149,90 na chave PIX abaixo.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-button-pix"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"name\": \"Wabox Store LTDA\",\n \"key\": \"12345678000199\",\n \"key_type\": \"cnpj\",\n \"message\": \"Para concluir o pedido #4821, pague R$ 149,90 na chave PIX abaixo.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar lista de opções (menu de seleção única)",
"request": {
"name": "Enviar lista de opções (menu de seleção única)",
"description": {
"content": "`button_label` (até 20 caracteres) é o texto do botão que abre o menu. As opções vão em `sections[].rows[]` (até 10 seções com `title` opcional, cada uma com até 10 linhas) ou no atalho `options[]` (até 10 linhas em uma única seção sem título). Envie um dos dois. Cada linha tem `id`, `title` (até 24 caracteres) e `description` opcional (até 72). A opção escolhida chega no webhook `list_response` com o `id` da linha.\n\n**Best effort.** Mensagens interativas não são um recurso oficial para contas comuns do WhatsApp. Elas são entregues como mensagens \"native flow\", e a renderização depende do app e da plataforma de quem recebe. Celulares (Android/iOS) exibem normalmente, mas o **WhatsApp Web e o WhatsApp Desktop não exibem** botões, lista nem carrossel. Eles mostram o placeholder \"mensagem de visualização única\" e a pessoa precisa abrir no celular. Outras APIs não-oficiais se comportam do mesmo jeito, e não há contorno conhecido, já que o conteúdo é cifrado igual para todos os dispositivos. Em versões antigas do app a mensagem pode chegar como texto simples. Botões `reply` voltam como webhook `buttons_response`; a opção escolhida em uma lista, como `list_response`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-option-list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"title\": \"Atendimento Wabox Store\",\n \"message\": \"Escolha o setor com o qual você quer falar:\",\n \"footer\": \"Seg. a sex., das 9h às 18h\",\n \"button_label\": \"Ver opções\",\n \"sections\": [\n {\n \"title\": \"Vendas\",\n \"rows\": [\n {\n \"id\": \"vendas_novo_pedido\",\n \"title\": \"Novo pedido\",\n \"description\": \"Fazer um orçamento ou comprar\"\n },\n {\n \"id\": \"vendas_status\",\n \"title\": \"Status do pedido\",\n \"description\": \"Acompanhar uma compra\"\n }\n ]\n },\n {\n \"title\": \"Suporte\",\n \"rows\": [\n {\n \"id\": \"suporte_tecnico\",\n \"title\": \"Suporte técnico\",\n \"description\": \"Problemas com o produto\"\n },\n {\n \"id\": \"suporte_financeiro\",\n \"title\": \"Financeiro\",\n \"description\": \"Boletos, notas fiscais e reembolsos\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-option-list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"title\": \"Atendimento Wabox Store\",\n \"message\": \"Escolha o setor com o qual você quer falar:\",\n \"footer\": \"Seg. a sex., das 9h às 18h\",\n \"button_label\": \"Ver opções\",\n \"sections\": [\n {\n \"title\": \"Vendas\",\n \"rows\": [\n {\n \"id\": \"vendas_novo_pedido\",\n \"title\": \"Novo pedido\",\n \"description\": \"Fazer um orçamento ou comprar\"\n },\n {\n \"id\": \"vendas_status\",\n \"title\": \"Status do pedido\",\n \"description\": \"Acompanhar uma compra\"\n }\n ]\n },\n {\n \"title\": \"Suporte\",\n \"rows\": [\n {\n \"id\": \"suporte_tecnico\",\n \"title\": \"Suporte técnico\",\n \"description\": \"Problemas com o produto\"\n },\n {\n \"id\": \"suporte_financeiro\",\n \"title\": \"Financeiro\",\n \"description\": \"Boletos, notas fiscais e reembolsos\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-option-list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"title\": \"Atendimento Wabox Store\",\n \"message\": \"Escolha o setor com o qual você quer falar:\",\n \"footer\": \"Seg. a sex., das 9h às 18h\",\n \"button_label\": \"Ver opções\",\n \"sections\": [\n {\n \"title\": \"Vendas\",\n \"rows\": [\n {\n \"id\": \"vendas_novo_pedido\",\n \"title\": \"Novo pedido\",\n \"description\": \"Fazer um orçamento ou comprar\"\n },\n {\n \"id\": \"vendas_status\",\n \"title\": \"Status do pedido\",\n \"description\": \"Acompanhar uma compra\"\n }\n ]\n },\n {\n \"title\": \"Suporte\",\n \"rows\": [\n {\n \"id\": \"suporte_tecnico\",\n \"title\": \"Suporte técnico\",\n \"description\": \"Problemas com o produto\"\n },\n {\n \"id\": \"suporte_financeiro\",\n \"title\": \"Financeiro\",\n \"description\": \"Boletos, notas fiscais e reembolsos\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-option-list"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"title\": \"Atendimento Wabox Store\",\n \"message\": \"Escolha o setor com o qual você quer falar:\",\n \"footer\": \"Seg. a sex., das 9h às 18h\",\n \"button_label\": \"Ver opções\",\n \"sections\": [\n {\n \"title\": \"Vendas\",\n \"rows\": [\n {\n \"id\": \"vendas_novo_pedido\",\n \"title\": \"Novo pedido\",\n \"description\": \"Fazer um orçamento ou comprar\"\n },\n {\n \"id\": \"vendas_status\",\n \"title\": \"Status do pedido\",\n \"description\": \"Acompanhar uma compra\"\n }\n ]\n },\n {\n \"title\": \"Suporte\",\n \"rows\": [\n {\n \"id\": \"suporte_tecnico\",\n \"title\": \"Suporte técnico\",\n \"description\": \"Problemas com o produto\"\n },\n {\n \"id\": \"suporte_financeiro\",\n \"title\": \"Financeiro\",\n \"description\": \"Boletos, notas fiscais e reembolsos\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar carrossel de cards",
"request": {
"name": "Enviar carrossel de cards",
"description": {
"content": "`message` é o texto que acompanha o carrossel e `cards[]` tem de 1 a 10 cards. Cada card tem `image` obrigatória (URL, data URL ou base64), `text`, `title`/`footer` opcionais e até 3 `buttons` nos mesmos formatos de `send-button-list` (reply, url, call, copy; `type` pode ser omitido). Botões `reply` voltam como `buttons_response`.\n\n**Best effort.** Mensagens interativas não são um recurso oficial para contas comuns do WhatsApp. Elas são entregues como mensagens \"native flow\", e a renderização depende do app e da plataforma de quem recebe. Celulares (Android/iOS) exibem normalmente, mas o **WhatsApp Web e o WhatsApp Desktop não exibem** botões, lista nem carrossel. Eles mostram o placeholder \"mensagem de visualização única\" e a pessoa precisa abrir no celular. Outras APIs não-oficiais se comportam do mesmo jeito, e não há contorno conhecido, já que o conteúdo é cifrado igual para todos os dispositivos. Em versões antigas do app a mensagem pode chegar como texto simples. Botões `reply` voltam como webhook `buttons_response`; a opção escolhida em uma lista, como `list_response`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-carousel"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Confira as ofertas da semana:\",\n \"cards\": [\n {\n \"image\": \"https://example.com/produtos/tenis-runner.jpg\",\n \"title\": \"Tênis Runner\",\n \"text\": \"De R$ 399,90 por R$ 299,90 até domingo.\",\n \"footer\": \"Frete grátis\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"quero_tenis_runner\",\n \"label\": \"Quero este\"\n },\n {\n \"type\": \"url\",\n \"label\": \"Ver na loja\",\n \"url\": \"https://example.com/p/tenis-runner\"\n }\n ]\n },\n {\n \"image\": \"https://example.com/produtos/mochila-urban.jpg\",\n \"title\": \"Mochila Urban\",\n \"text\": \"Compartimento para notebook de 15\\\". R$ 189,90.\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"quero_mochila_urban\",\n \"label\": \"Quero este\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-carousel"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Confira as ofertas da semana:\",\n \"cards\": [\n {\n \"image\": \"https://example.com/produtos/tenis-runner.jpg\",\n \"title\": \"Tênis Runner\",\n \"text\": \"De R$ 399,90 por R$ 299,90 até domingo.\",\n \"footer\": \"Frete grátis\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"quero_tenis_runner\",\n \"label\": \"Quero este\"\n },\n {\n \"type\": \"url\",\n \"label\": \"Ver na loja\",\n \"url\": \"https://example.com/p/tenis-runner\"\n }\n ]\n },\n {\n \"image\": \"https://example.com/produtos/mochila-urban.jpg\",\n \"title\": \"Mochila Urban\",\n \"text\": \"Compartimento para notebook de 15\\\". R$ 189,90.\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"quero_mochila_urban\",\n \"label\": \"Quero este\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-carousel"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Confira as ofertas da semana:\",\n \"cards\": [\n {\n \"image\": \"https://example.com/produtos/tenis-runner.jpg\",\n \"title\": \"Tênis Runner\",\n \"text\": \"De R$ 399,90 por R$ 299,90 até domingo.\",\n \"footer\": \"Frete grátis\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"quero_tenis_runner\",\n \"label\": \"Quero este\"\n },\n {\n \"type\": \"url\",\n \"label\": \"Ver na loja\",\n \"url\": \"https://example.com/p/tenis-runner\"\n }\n ]\n },\n {\n \"image\": \"https://example.com/produtos/mochila-urban.jpg\",\n \"title\": \"Mochila Urban\",\n \"text\": \"Compartimento para notebook de 15\\\". R$ 189,90.\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"quero_mochila_urban\",\n \"label\": \"Quero este\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-carousel"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Confira as ofertas da semana:\",\n \"cards\": [\n {\n \"image\": \"https://example.com/produtos/tenis-runner.jpg\",\n \"title\": \"Tênis Runner\",\n \"text\": \"De R$ 399,90 por R$ 299,90 até domingo.\",\n \"footer\": \"Frete grátis\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"quero_tenis_runner\",\n \"label\": \"Quero este\"\n },\n {\n \"type\": \"url\",\n \"label\": \"Ver na loja\",\n \"url\": \"https://example.com/p/tenis-runner\"\n }\n ]\n },\n {\n \"image\": \"https://example.com/produtos/mochila-urban.jpg\",\n \"title\": \"Mochila Urban\",\n \"text\": \"Compartimento para notebook de 15\\\". R$ 189,90.\",\n \"buttons\": [\n {\n \"type\": \"reply\",\n \"id\": \"quero_mochila_urban\",\n \"label\": \"Quero este\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Criar evento de calendário",
"request": {
"name": "Criar evento de calendário",
"description": {
"content": "Cria um evento do WhatsApp no chat (`phone` costuma ser um grupo). `start_at`/`end_at` em ISO-8601 com fuso (ex.: `2026-09-15T14:00:00Z`); opcionais `description`, `location` (`name`, `latitude`, `longitude`), `join_link` (link de chamada/reunião) e `extra_guests_allowed`. Os convidados respondem pelo app ou por `send-event-response`; as confirmações chegam como webhook `event_response`. Guarde o `message_id` retornado, que é necessário para editar ou cancelar o evento com `send-edit-event`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-event"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"name\": \"Reunião de planejamento\",\n \"description\": \"Alinhamento das metas do próximo trimestre.\",\n \"start_at\": \"2026-09-15T14:00:00Z\",\n \"end_at\": \"2026-09-15T15:00:00Z\",\n \"location\": {\n \"name\": \"Escritório Wabox — sala 2\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308\n },\n \"join_link\": \"https://meet.example.com/wabox-planejamento\",\n \"extra_guests_allowed\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Evento enfileirado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-event"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"name\": \"Reunião de planejamento\",\n \"description\": \"Alinhamento das metas do próximo trimestre.\",\n \"start_at\": \"2026-09-15T14:00:00Z\",\n \"end_at\": \"2026-09-15T15:00:00Z\",\n \"location\": {\n \"name\": \"Escritório Wabox — sala 2\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308\n },\n \"join_link\": \"https://meet.example.com/wabox-planejamento\",\n \"extra_guests_allowed\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-event"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"name\": \"Reunião de planejamento\",\n \"description\": \"Alinhamento das metas do próximo trimestre.\",\n \"start_at\": \"2026-09-15T14:00:00Z\",\n \"end_at\": \"2026-09-15T15:00:00Z\",\n \"location\": {\n \"name\": \"Escritório Wabox — sala 2\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308\n },\n \"join_link\": \"https://meet.example.com/wabox-planejamento\",\n \"extra_guests_allowed\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-event"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"name\": \"Reunião de planejamento\",\n \"description\": \"Alinhamento das metas do próximo trimestre.\",\n \"start_at\": \"2026-09-15T14:00:00Z\",\n \"end_at\": \"2026-09-15T15:00:00Z\",\n \"location\": {\n \"name\": \"Escritório Wabox — sala 2\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308\n },\n \"join_link\": \"https://meet.example.com/wabox-planejamento\",\n \"extra_guests_allowed\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Editar ou cancelar um evento",
"request": {
"name": "Editar ou cancelar um evento",
"description": {
"content": "Envie o evento completo novamente (todos os campos de `send-event`) com `edit_message_id` igual ao `message_id` do evento original. `canceled: true` cancela o evento. A resposta devolve o mesmo `message_id` do evento editado.\n\n**Limitação.** Só funciona para eventos que esta instância criou (ou recebeu) desde o último restart do engine, porque o segredo da mensagem fica em memória. Se o evento não for encontrado, o webhook `delivery` chega com `error_code: message_not_found`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-edit-event"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"edit_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"name\": \"Reunião de planejamento\",\n \"description\": \"Alinhamento das metas do próximo trimestre. Novo horário!\",\n \"start_at\": \"2026-09-15T15:00:00Z\",\n \"end_at\": \"2026-09-15T16:00:00Z\",\n \"location\": {\n \"name\": \"Escritório Wabox — sala 2\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308\n },\n \"join_link\": \"https://meet.example.com/wabox-planejamento\",\n \"extra_guests_allowed\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Edição enfileirada; `message_id` é o id do evento editado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-edit-event"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"edit_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"name\": \"Reunião de planejamento\",\n \"description\": \"Alinhamento das metas do próximo trimestre. Novo horário!\",\n \"start_at\": \"2026-09-15T15:00:00Z\",\n \"end_at\": \"2026-09-15T16:00:00Z\",\n \"location\": {\n \"name\": \"Escritório Wabox — sala 2\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308\n },\n \"join_link\": \"https://meet.example.com/wabox-planejamento\",\n \"extra_guests_allowed\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-edit-event"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"edit_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"name\": \"Reunião de planejamento\",\n \"description\": \"Alinhamento das metas do próximo trimestre. Novo horário!\",\n \"start_at\": \"2026-09-15T15:00:00Z\",\n \"end_at\": \"2026-09-15T16:00:00Z\",\n \"location\": {\n \"name\": \"Escritório Wabox — sala 2\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308\n },\n \"join_link\": \"https://meet.example.com/wabox-planejamento\",\n \"extra_guests_allowed\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-edit-event"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"edit_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"name\": \"Reunião de planejamento\",\n \"description\": \"Alinhamento das metas do próximo trimestre. Novo horário!\",\n \"start_at\": \"2026-09-15T15:00:00Z\",\n \"end_at\": \"2026-09-15T16:00:00Z\",\n \"location\": {\n \"name\": \"Escritório Wabox — sala 2\",\n \"latitude\": -23.55052,\n \"longitude\": -46.633308\n },\n \"join_link\": \"https://meet.example.com/wabox-planejamento\",\n \"extra_guests_allowed\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Responder a um evento (RSVP)",
"request": {
"name": "Responder a um evento (RSVP)",
"description": {
"content": "Confirma presença em um evento. `event_message_id` é o `message_id` do evento e `response` é `going`, `not_going` ou `maybe` (aceita maiúsculas). `extra_guests` (0–99) informa acompanhantes quando o evento permite. Em grupos, use `participant` (telefone de quem criou o evento) e `from_me` para ajudar o engine a localizar a mensagem. Não aceita `delay_message`/`delay_typing`. A resposta devolve um novo `message_id` (o da mensagem de RSVP), não o do evento.\n\n**Limitação.** Só funciona para eventos que esta instância criou ou recebeu desde o último restart do engine, porque o segredo da mensagem fica em memória. Se o evento não for encontrado, o webhook `delivery` chega com `error_code: message_not_found`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; o resultado chega no webhook `delivery`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-event-response"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"event_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"response\": \"going\",\n \"extra_guests\": 1,\n \"from_me\": false,\n \"participant\": \"5511977776666\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "RSVP enfileirado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-event-response"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"event_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"response\": \"going\",\n \"extra_guests\": 1,\n \"from_me\": false,\n \"participant\": \"5511977776666\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-event-response"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"event_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"response\": \"going\",\n \"extra_guests\": 1,\n \"from_me\": false,\n \"participant\": \"5511977776666\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-event-response"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"120363012345678901-group\",\n \"event_message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"response\": \"going\",\n \"extra_guests\": 1,\n \"from_me\": false,\n \"participant\": \"5511977776666\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Publicar status de texto",
"request": {
"name": "Publicar status de texto",
"description": {
"content": "Publica no seu status (stories). Quem vê segue a sua configuração de privacidade de status. O destino é sempre `status@broadcast`, então não envie `phone`. Aceita apenas `delay_message` (não há `delay_typing`). Opcionais: `background_color` (`#RRGGBB`; padrão verde do WhatsApp) e `font` (índice da fonte do WhatsApp, 0–9).\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-text-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"Promoção relâmpago: 20% off até as 18h de hoje!\",\n \"background_color\": \"#075E54\",\n \"font\": 2\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Status enfileirado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-text-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"Promoção relâmpago: 20% off até as 18h de hoje!\",\n \"background_color\": \"#075E54\",\n \"font\": 2\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-text-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"Promoção relâmpago: 20% off até as 18h de hoje!\",\n \"background_color\": \"#075E54\",\n \"font\": 2\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-text-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"Promoção relâmpago: 20% off até as 18h de hoje!\",\n \"background_color\": \"#075E54\",\n \"font\": 2\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Publicar status de imagem",
"request": {
"name": "Publicar status de imagem",
"description": {
"content": "Publica no seu status (stories). Quem vê segue a sua configuração de privacidade de status. O destino é sempre `status@broadcast`, então não envie `phone`. Aceita apenas `delay_message` (não há `delay_typing`). `image` aceita URL, data URL ou base64; `caption` é a legenda e `mime_type` sobrescreve o tipo detectado.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-image-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"image\": \"https://example.com/status/lancamento.jpg\",\n \"caption\": \"Novidades chegando na próxima semana\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Status enfileirado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-image-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"image\": \"https://example.com/status/lancamento.jpg\",\n \"caption\": \"Novidades chegando na próxima semana\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-image-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"image\": \"https://example.com/status/lancamento.jpg\",\n \"caption\": \"Novidades chegando na próxima semana\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-image-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"image\": \"https://example.com/status/lancamento.jpg\",\n \"caption\": \"Novidades chegando na próxima semana\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Publicar status de vídeo",
"request": {
"name": "Publicar status de vídeo",
"description": {
"content": "Publica no seu status (stories). Quem vê segue a sua configuração de privacidade de status. O destino é sempre `status@broadcast`, então não envie `phone`. Aceita apenas `delay_message` (não há `delay_typing`). `video` aceita URL, data URL ou base64 de um MP4; `caption` é a legenda e `mime_type` sobrescreve o tipo detectado.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-video-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"video\": \"https://example.com/status/bastidores.mp4\",\n \"caption\": \"Bastidores da nova coleção\",\n \"mime_type\": \"video/mp4\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Status enfileirado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-video-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"video\": \"https://example.com/status/bastidores.mp4\",\n \"caption\": \"Bastidores da nova coleção\",\n \"mime_type\": \"video/mp4\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-video-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"video\": \"https://example.com/status/bastidores.mp4\",\n \"caption\": \"Bastidores da nova coleção\",\n \"mime_type\": \"video/mp4\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-video-status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"video\": \"https://example.com/status/bastidores.mp4\",\n \"caption\": \"Bastidores da nova coleção\",\n \"mime_type\": \"video/mp4\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Convidar alguém para administrar seu canal",
"request": {
"name": "Convidar alguém para administrar seu canal",
"description": {
"content": "Envia para `phone` um card de convite para administrar o canal `newsletter_id` (formato `@newsletter`), com `caption` opcional. Para publicar em um canal, use qualquer endpoint `send-*` com `phone: \"@newsletter\"`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id definitivo no WhatsApp (`id` é um alias dele) e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`. `delay_message` e `delay_typing` (segundos, 0–15) funcionam como nos demais envios. O primeiro substitui o intervalo aleatório da instância para esta mensagem, o segundo mostra \"digitando…\" antes de enviar.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-newsletter-admin-invite"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"newsletter_id\": \"120363012345678901@newsletter\",\n \"caption\": \"Quer me ajudar a administrar o canal da Wabox Store?\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Convite enfileirado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-newsletter-admin-invite"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"newsletter_id\": \"120363012345678901@newsletter\",\n \"caption\": \"Quer me ajudar a administrar o canal da Wabox Store?\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-newsletter-admin-invite"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"newsletter_id\": \"120363012345678901@newsletter\",\n \"caption\": \"Quer me ajudar a administrar o canal da Wabox Store?\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-newsletter-admin-invite"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"newsletter_id\": \"120363012345678901@newsletter\",\n \"caption\": \"Quer me ajudar a administrar o canal da Wabox Store?\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Queue",
"description": {
"content": "Mensagens aguardando envio (pacing anti-ban ou instância desconectada).",
"type": "text/plain"
},
"item": [
{
"name": "Listar mensagens na fila",
"request": {
"name": "Listar mensagens na fila",
"description": {
"content": "Mensagens enviadas pela API que ainda não saíram, normalmente porque a instância está desconectada. O Wabox as entrega em ordem assim que ela reconecta. A lista é paginada por `page` e `page_size` (máx. 100), do mais antigo para o mais novo. `wabox_id` é o id retornado no envio; `message_id` é o id que a mensagem terá no WhatsApp; `payload` é o conteúdo original.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"queue"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Página da fila.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"queue"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"phone\": \"5511988887777\",\n \"type\": \"text\",\n \"payload\": {\n \"type\": \"text\",\n \"message\": \"Olá do Wabox!\"\n },\n \"created_at\": \"2026-08-18T12:07:00.000Z\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total\": 1\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"queue"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Limpar a fila",
"request": {
"name": "Limpar a fila",
"description": {
"content": "Remove todas as mensagens ainda na fila desta instância, que não serão enviadas. `removed` é a quantidade descartada. Mensagens já em envio não são afetadas.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"queue"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Fila limpa.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"queue"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true,\n \"removed\": 3\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"queue"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Remover uma mensagem da fila",
"request": {
"name": "Remover uma mensagem da fila",
"description": {
"content": "Descarta uma mensagem específica pelo `wabox_id` retornado no envio. `value` é `false` (e `removed` 0) quando ela não está mais na fila, porque já foi enviada ou nunca existiu.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"queue",
":wabox_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01",
"key": "wabox_id",
"description": "(Required) `wabox_id` retornado no envio."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Resultado da remoção.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"queue",
":wabox_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01",
"key": "wabox_id",
"description": "(Required) `wabox_id` retornado no envio."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true,\n \"removed\": 1\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"queue",
":wabox_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01",
"key": "wabox_id",
"description": "(Required) `wabox_id` retornado no envio."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Chats",
"description": {
"content": "Lista de conversas, ações (arquivar, silenciar, fixar, ler) e mensagens temporárias.",
"type": "text/plain"
},
"item": [
{
"name": "Listar conversas",
"request": {
"name": "Listar conversas",
"description": {
"content": "O engine mantém, por instância, uma lista de conversas com só os metadados, nunca o conteúdo das mensagens. A lista começa com o histórico que o celular envia após o pareamento e depois o engine a atualiza com o tráfego e com as mudanças feitas no celular. Conversas fixadas vêm primeiro, depois as mais recentes. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Lista paginada de conversas.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"phone\": \"5511988887777\",\n \"name\": \"Maria Silva\",\n \"is_group\": false,\n \"last_message_at\": \"2026-08-20T11:30:00.000Z\",\n \"unread_count\": 2,\n \"marked_unread\": false,\n \"archived\": false,\n \"pinned\": true,\n \"muted\": true,\n \"muted_until\": \"2026-08-21T11:30:00.000Z\",\n \"ephemeral_seconds\": 0\n }\n ],\n \"page\": 1,\n \"page_size\": 100,\n \"total\": 1\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Detalhes da conversa",
"request": {
"name": "Detalhes da conversa",
"description": {
"content": "Contagem de não lidas, flags de arquivada, fixada e silenciada, e timer de mensagens temporárias. Responde 404 `chat_not_found` quando o engine ainda não viu a conversa. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Dados da conversa.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"phone\": \"5511988887777\",\n \"name\": \"Maria Silva\",\n \"is_group\": false,\n \"last_message_at\": \"2026-08-20T11:30:00.000Z\",\n \"unread_count\": 2,\n \"marked_unread\": false,\n \"archived\": false,\n \"pinned\": true,\n \"muted\": true,\n \"muted_until\": \"2026-08-21T11:30:00.000Z\",\n \"ephemeral_seconds\": 0\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Conversa desconhecida para o engine.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"chat_not_found\",\n \"message\": \"Chat not found\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Mensagens recentes da conversa",
"request": {
"name": "Mensagens recentes da conversa",
"description": {
"content": "Ao parear, o celular envia ao Wabox as conversas recentes com as últimas mensagens de cada uma. O Wabox guarda até 50 mensagens por conversa (as mais recentes) em object storage e as devolve aqui no mesmo formato do webhook `received`, sem o envelope (`type`, `event_id`, `instance_id`). A mídia vem só com metadados (`download_error` = `media not downloaded (history sync)`) e nunca é baixada no sync. Não é histórico completo: mensagens mais antigas que as sincronizadas pelo celular e conversas sem atividade recente podem não existir aqui (`messages` vazio, nunca 404). Depois do pareamento, o tráfego novo chega só pelos webhooks. Esta rota não acompanha mensagens ao vivo. Não exige a instância conectada. Desligue com `settings.history_enabled = false` (apaga o que já foi guardado); logout e exclusão da instância também apagam.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Até 50 mensagens, da mais antiga para a mais recente. `messages` vazio quando o celular não sincronizou essa conversa (ou `enabled` = false).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"phone\": \"5511988887777\",\n \"enabled\": true,\n \"synced_at\": \"2026-09-16T12:00:05.000Z\",\n \"messages\": [\n {\n \"momment\": 1789560000000,\n \"message_id\": \"3EB0C767D26A8B1F2C9A\",\n \"phone\": \"5511988887777\",\n \"from_me\": false,\n \"from_api\": false,\n \"is_group\": false,\n \"is_newsletter\": false,\n \"is_edit\": false,\n \"forwarded\": false,\n \"broadcast\": false,\n \"waiting_message\": false,\n \"status\": \"RECEIVED\",\n \"chat_name\": \"Maria\",\n \"sender_name\": \"Maria\",\n \"text\": {\n \"message\": \"Oi, ainda tem o produto?\"\n }\n },\n {\n \"momment\": 1789560060000,\n \"message_id\": \"3EB0A1B2C3D4E5F60718\",\n \"phone\": \"5511988887777\",\n \"from_me\": true,\n \"from_api\": false,\n \"is_group\": false,\n \"is_newsletter\": false,\n \"is_edit\": false,\n \"forwarded\": false,\n \"broadcast\": false,\n \"waiting_message\": false,\n \"status\": \"READ\",\n \"text\": {\n \"message\": \"Tem sim! Posso separar pra você.\"\n }\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Histórico não configurado neste ambiente.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Service Unavailable",
"code": 503,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"history_not_configured\",\n \"message\": \"Chat history is not configured on this server\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Arquivar, silenciar, fixar, marcar como lida ou não lida, ou apagar conversa",
"request": {
"name": "Arquivar, silenciar, fixar, marcar como lida ou não lida, ou apagar conversa",
"description": {
"content": "`action` é um destes valores: archive | unarchive | mute | unmute | pin | unpin | read | unread | delete. Para `mute`, envie o body `{ \"mute_seconds\": 28800 }` (sem `mute_seconds`, silencia para sempre). Nas demais ações o body é opcional. A mudança aparece no celular pelo app state do WhatsApp. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
":action"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
},
{
"disabled": false,
"type": "any",
"value": "archive",
"key": "action",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"mute_seconds\": 28800\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Ação aplicada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
":action"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
},
{
"disabled": false,
"type": "any",
"value": "archive",
"key": "action",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"mute_seconds\": 28800\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
":action"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
},
{
"disabled": false,
"type": "any",
"value": "archive",
"key": "action",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"mute_seconds\": 28800\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
":action"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
},
{
"disabled": false,
"type": "any",
"value": "archive",
"key": "action",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"mute_seconds\": 28800\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
":action"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
},
{
"disabled": false,
"type": "any",
"value": "archive",
"key": "action",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"mute_seconds\": 28800\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Timer de mensagens temporárias",
"request": {
"name": "Timer de mensagens temporárias",
"description": {
"content": "O body é `{ \"value\": 0 | 86400 | 604800 | 7776000 }`, em segundos. 0 desativa. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"expiration"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"value\": 86400\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Timer atualizado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"expiration"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": 86400\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"expiration"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": 86400\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"expiration"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": 86400\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"expiration"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone do contato ou id do grupo."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": 86400\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Contacts",
"description": {
"content": "Contatos, foto de perfil, verificação de números e bloqueio.",
"type": "text/plain"
},
"item": [
{
"name": "Listar contatos",
"request": {
"name": "Listar contatos",
"description": {
"content": "Contatos que o número conectado conhece (agenda e pessoas vistas em conversas), paginados e ordenados por telefone. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Lista paginada de contatos.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"phone\": \"5511988887777\",\n \"lid\": \"987654321098765@lid\",\n \"name\": \"Maria Silva\",\n \"short_name\": \"Maria\",\n \"push_name\": \"Mari\",\n \"is_business\": false,\n \"in_contacts\": true\n }\n ],\n \"page\": 1,\n \"page_size\": 100,\n \"total\": 1\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Listar contatos bloqueados",
"request": {
"name": "Listar contatos bloqueados",
"description": {
"content": "Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
"blocked"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Telefones bloqueados.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
"blocked"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n \"5511977776666\"\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
"blocked"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
"blocked"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
"blocked"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Detalhes do contato",
"request": {
"name": "Detalhes do contato",
"description": {
"content": "Nome na agenda, push name, nome comercial, recado (\"about\") e se o número está no WhatsApp. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Dados do contato.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"phone\": \"5511988887777\",\n \"lid\": \"987654321098765@lid\",\n \"name\": \"Maria Silva\",\n \"short_name\": \"Maria\",\n \"push_name\": \"Mari\",\n \"is_business\": false,\n \"in_contacts\": true,\n \"about\": \"Disponível\",\n \"exists\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "URL da foto de perfil (usuário ou grupo)",
"request": {
"name": "URL da foto de perfil (usuário ou grupo)",
"description": {
"content": "`url` é um link temporário do CDN do WhatsApp; `null` quando o usuário oculta a foto ou não tem uma. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "URL temporária da foto.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"url\": \"https://pps.whatsapp.net/v/t61.24694-24/abc.jpg?oe=1&oh=2\",\n \"id\": \"1700000000\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Online e visto por último do contato",
"request": {
"name": "Online e visto por último do contato",
"description": {
"content": "`status` é `AVAILABLE` (online) ou `UNAVAILABLE` (offline); `last_seen` é o visto por último (epoch ms) quando o contato o compartilha, e `momment` é quando o Wabox recebeu a última atualização. A primeira consulta de um contato pede ao WhatsApp para avisar as mudanças de presença dele e espera a resposta por até 3 s; as seguintes devolvem o último estado conhecido, que também chega no webhook `chat_presence`. Campos `null`: o contato oculta a presença na privacidade, não tem conversa com o número ou ainda não respondeu. O WhatsApp só envia a presença de contatos enquanto o número está online: ligue `always_online` nas configurações (ou use `POST /send-presence` com `available`). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Última presença conhecida.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"phone\": \"5511988887777\",\n \"status\": \"UNAVAILABLE\",\n \"last_seen\": 1786968480000,\n \"momment\": 1786968540000\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"presence"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Verificar se o número está no WhatsApp",
"request": {
"name": "Verificar se o número está no WhatsApp",
"description": {
"content": "Devolve `exists` e, quando o número está registrado, o telefone canônico e o JID. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-exists",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Resultado da verificação.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-exists",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"phone\": \"5511988887777\",\n \"exists\": true,\n \"canonical_phone\": \"5511988887777\",\n \"jid\": \"5511988887777@s.whatsapp.net\",\n \"lid\": \"987654321098765@lid\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-exists",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-exists",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-exists",
":phone"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Verificar até 50 números de uma vez",
"request": {
"name": "Verificar até 50 números de uma vez",
"description": {
"content": "Cada telefone recebe seu próprio resultado, na mesma ordem em que você enviou. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-exists-batch"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phones\": [\n \"5511988887777\",\n \"5511900000000\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Um resultado por telefone.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-exists-batch"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phones\": [\n \"5511988887777\",\n \"5511900000000\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"phone\": \"5511988887777\",\n \"exists\": true,\n \"canonical_phone\": \"5511988887777\",\n \"jid\": \"5511988887777@s.whatsapp.net\",\n \"lid\": \"987654321098765@lid\"\n },\n {\n \"phone\": \"5511900000000\",\n \"exists\": false\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-exists-batch"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phones\": [\n \"5511988887777\",\n \"5511900000000\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-exists-batch"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phones\": [\n \"5511988887777\",\n \"5511900000000\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"phone-exists-batch"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phones\": [\n \"5511988887777\",\n \"5511900000000\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Bloquear contato",
"request": {
"name": "Bloquear contato",
"description": {
"content": "Devolve a lista de bloqueados resultante. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"block"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511977776666",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Lista de bloqueados após a ação.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"block"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511977776666",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"blocked\": [\n \"5511977776666\"\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"block"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511977776666",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"block"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511977776666",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"block"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511977776666",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Desbloquear contato",
"request": {
"name": "Desbloquear contato",
"description": {
"content": "Devolve a lista de bloqueados resultante. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"unblock"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511977776666",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Lista de bloqueados após a ação.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"unblock"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511977776666",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"blocked\": [\n \"5511977776666\"\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"unblock"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511977776666",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"unblock"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511977776666",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"contacts",
":phone",
"unblock"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511977776666",
"key": "phone",
"description": "(Required) "
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Profile",
"description": {
"content": "Nome, recado e foto do número conectado.",
"type": "text/plain"
},
"item": [
{
"name": "Definir o nome do perfil (push name)",
"request": {
"name": "Definir o nome do perfil (push name)",
"description": {
"content": "O body é `{ \"value\": \"...\" }` (máx. 25 caracteres). Também disponível em `PUT /profile-name` (compat z-api). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"name"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Loja da Maria\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Nome atualizado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"name"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Loja da Maria\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"name"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Loja da Maria\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"name"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Loja da Maria\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"name"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Loja da Maria\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Definir o recado (\"about\")",
"request": {
"name": "Definir o recado (\"about\")",
"description": {
"content": "O body é `{ \"value\": \"...\" }` (máx. 139 caracteres; string vazia limpa o recado). Também disponível em `PUT /profile-description` (compat z-api). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"about"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Atendimento de segunda a sexta, das 9h às 18h.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Recado atualizado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"about"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Atendimento de segunda a sexta, das 9h às 18h.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"about"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Atendimento de segunda a sexta, das 9h às 18h.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"about"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Atendimento de segunda a sexta, das 9h às 18h.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"about"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"Atendimento de segunda a sexta, das 9h às 18h.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Definir a foto de perfil",
"request": {
"name": "Definir a foto de perfil",
"description": {
"content": "O body é `{ \"value\": \"\" }`, com uma imagem JPEG/PNG. A API redimensiona a imagem para 640px. `mime_type` é opcional (sobrescreve o tipo detectado). Também disponível em `PUT /profile-picture` (compat z-api). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"https://exemplo.com/foto.jpg\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Foto atualizada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"https://exemplo.com/foto.jpg\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"https://exemplo.com/foto.jpg\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"https://exemplo.com/foto.jpg\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"https://exemplo.com/foto.jpg\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Remover a foto de perfil",
"request": {
"name": "Remover a foto de perfil",
"description": {
"content": "Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Foto removida.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"value\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"profile",
"picture"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Groups",
"description": {
"content": "Criar, listar, administrar participantes, links de convite e configurações.",
"type": "text/plain"
},
"item": [
{
"name": "Criar grupo",
"request": {
"name": "Criar grupo",
"description": {
"content": "Você vira super admin automaticamente. Participantes que não puderam ser adicionados aparecem na lista de participantes do grupo retornado. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Equipe Wabox\",\n \"participants\": [\n \"5511988887777\",\n \"5511977776666\"\n ],\n \"description\": \"Grupo de testes\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Grupo criado (metadados + participantes).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Equipe Wabox\",\n \"participants\": [\n \"5511988887777\",\n \"5511977776666\"\n ],\n \"description\": \"Grupo de testes\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"120363012345678901-group\",\n \"name\": \"Equipe Wabox\",\n \"description\": \"Grupo de testes\",\n \"owner\": \"5511999998888\",\n \"created_at\": \"2026-08-01T10:00:00.000Z\",\n \"participants\": [\n {\n \"phone\": \"5511999998888\",\n \"lid\": \"123456789012345@lid\",\n \"is_admin\": true,\n \"is_super_admin\": true\n },\n {\n \"phone\": \"5511988887777\",\n \"is_admin\": false,\n \"is_super_admin\": false\n }\n ],\n \"participant_count\": 2,\n \"announce\": false,\n \"locked\": false,\n \"join_approval_required\": false,\n \"member_add_mode\": \"all_member_add\",\n \"ephemeral_seconds\": 0,\n \"is_community\": false,\n \"suspended\": false\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Equipe Wabox\",\n \"participants\": [\n \"5511988887777\",\n \"5511977776666\"\n ],\n \"description\": \"Grupo de testes\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Equipe Wabox\",\n \"participants\": [\n \"5511988887777\",\n \"5511977776666\"\n ],\n \"description\": \"Grupo de testes\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Equipe Wabox\",\n \"participants\": [\n \"5511988887777\",\n \"5511977776666\"\n ],\n \"description\": \"Grupo de testes\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Listar grupos",
"request": {
"name": "Listar grupos",
"description": {
"content": "Grupos dos quais o número participa. A resposta omite os participantes, a menos que `include_participants=true`. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Lista de grupos em `data`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"120363012345678901-group\",\n \"name\": \"Equipe Wabox\",\n \"description\": \"Grupo de testes\",\n \"owner\": \"5511999998888\",\n \"created_at\": \"2026-08-01T10:00:00.000Z\",\n \"participants\": [],\n \"participant_count\": 2,\n \"announce\": false,\n \"locked\": false,\n \"join_approval_required\": false,\n \"member_add_mode\": \"all_member_add\",\n \"ephemeral_seconds\": 0,\n \"is_community\": false,\n \"suspended\": false\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Informações do grupo pelo link de convite",
"request": {
"name": "Informações do grupo pelo link de convite",
"description": {
"content": "`?invite=`. Não entra no grupo, só consulta. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
"invite-info"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Metadados do grupo (sem participantes).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
"invite-info"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"120363012345678901-group\",\n \"name\": \"Equipe Wabox\",\n \"description\": \"Grupo de testes\",\n \"owner\": \"5511999998888\",\n \"created_at\": \"2026-08-01T10:00:00.000Z\",\n \"participants\": [],\n \"participant_count\": 2,\n \"announce\": false,\n \"locked\": false,\n \"join_approval_required\": false,\n \"member_add_mode\": \"all_member_add\",\n \"ephemeral_seconds\": 0,\n \"is_community\": false,\n \"suspended\": false\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
"invite-info"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
"invite-info"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
"invite-info"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Entrar em um grupo pelo link de convite",
"request": {
"name": "Entrar em um grupo pelo link de convite",
"description": {
"content": "Body `{ \"invite\": \"\" }`. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
"join"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"invite\": \"https://chat.whatsapp.com/AbCdEfGhIjK123456789\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Id do grupo em que você entrou.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
"join"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"invite\": \"https://chat.whatsapp.com/AbCdEfGhIjK123456789\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"group_id\": \"120363012345678901-group\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
"join"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"invite\": \"https://chat.whatsapp.com/AbCdEfGhIjK123456789\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
"join"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"invite\": \"https://chat.whatsapp.com/AbCdEfGhIjK123456789\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
"join"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"invite\": \"https://chat.whatsapp.com/AbCdEfGhIjK123456789\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Metadados e participantes do grupo",
"request": {
"name": "Metadados e participantes do grupo",
"description": {
"content": "Id do grupo como devolvido pela API / webhooks: `-group` (o JID bruto `@g.us` também é aceito). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Metadados do grupo com a lista de participantes.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"120363012345678901-group\",\n \"name\": \"Equipe Wabox\",\n \"description\": \"Grupo de testes\",\n \"owner\": \"5511999998888\",\n \"created_at\": \"2026-08-01T10:00:00.000Z\",\n \"participants\": [\n {\n \"phone\": \"5511999998888\",\n \"lid\": \"123456789012345@lid\",\n \"is_admin\": true,\n \"is_super_admin\": true\n },\n {\n \"phone\": \"5511988887777\",\n \"is_admin\": false,\n \"is_super_admin\": false\n }\n ],\n \"participant_count\": 2,\n \"announce\": false,\n \"locked\": false,\n \"join_approval_required\": false,\n \"member_add_mode\": \"all_member_add\",\n \"ephemeral_seconds\": 0,\n \"is_community\": false,\n \"suspended\": false\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Atualizar nome / descrição / foto / configurações",
"request": {
"name": "Atualizar nome / descrição / foto / configurações",
"description": {
"content": "O body é parcial, então envie só os campos que quer alterar. `remove_picture: true` remove a foto; `description: \"\"` limpa a descrição. Id do grupo como devolvido pela API / webhooks: `-group` (o JID bruto `@g.us` também é aceito). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Equipe Wabox\",\n \"description\": \"Grupo de testes\",\n \"announce\": true,\n \"ephemeral_seconds\": 604800\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Grupo atualizado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Equipe Wabox\",\n \"description\": \"Grupo de testes\",\n \"announce\": true,\n \"ephemeral_seconds\": 604800\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"updated\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Equipe Wabox\",\n \"description\": \"Grupo de testes\",\n \"announce\": true,\n \"ephemeral_seconds\": 604800\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Equipe Wabox\",\n \"description\": \"Grupo de testes\",\n \"announce\": true,\n \"ephemeral_seconds\": 604800\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Equipe Wabox\",\n \"description\": \"Grupo de testes\",\n \"announce\": true,\n \"ephemeral_seconds\": 604800\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Link de convite",
"request": {
"name": "Link de convite",
"description": {
"content": "Somente admins. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"invite-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Link e código do convite atual.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"invite-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"url\": \"https://chat.whatsapp.com/AbCdEfGhIjK123456789\",\n \"code\": \"AbCdEfGhIjK123456789\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"invite-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"invite-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"invite-link"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Revogar o link de convite e gerar um novo",
"request": {
"name": "Revogar o link de convite e gerar um novo",
"description": {
"content": "O link anterior deixa de funcionar. Somente admins. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"invite-link",
"revoke"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Novo link e código do convite.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"invite-link",
"revoke"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"url\": \"https://chat.whatsapp.com/AbCdEfGhIjK123456789\",\n \"code\": \"AbCdEfGhIjK123456789\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"invite-link",
"revoke"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"invite-link",
"revoke"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"invite-link",
"revoke"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Adicionar / remover / promover / rebaixar / aprovar / rejeitar participantes",
"request": {
"name": "Adicionar / remover / promover / rebaixar / aprovar / rejeitar participantes",
"description": {
"content": "Body `{ \"action\": \"add\" | \"remove\" | \"promote\" | \"demote\" | \"approve\" | \"reject\", \"phones\": [...] }`. Cada telefone recebe seu próprio resultado (`error` é o status do WhatsApp: 403 não permitido, 408 saiu recentemente, 409 já é membro…). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"participants"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"add\",\n \"phones\": [\n \"5511977776666\",\n \"5511900000000\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Um resultado por telefone em `data`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"participants"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"add\",\n \"phones\": [\n \"5511977776666\",\n \"5511900000000\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"phone\": \"5511977776666\",\n \"ok\": true\n },\n {\n \"phone\": \"5511900000000\",\n \"ok\": false,\n \"error\": \"403\"\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"participants"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"add\",\n \"phones\": [\n \"5511977776666\",\n \"5511900000000\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"participants"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"add\",\n \"phones\": [\n \"5511977776666\",\n \"5511900000000\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"participants"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"add\",\n \"phones\": [\n \"5511977776666\",\n \"5511900000000\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Solicitações de entrada pendentes",
"request": {
"name": "Solicitações de entrada pendentes",
"description": {
"content": "Para grupos com aprovação de entrada ativada (`join_approval_required`). Aprove ou rejeite com `POST /groups/{id}/participants` (`action: \"approve\" | \"reject\"`). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"requests"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Solicitações pendentes em `data`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"requests"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"phone\": \"5511966665555\",\n \"requested_at\": \"2026-08-20T11:00:00.000Z\"\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"requests"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"requests"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"requests"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Sair do grupo",
"request": {
"name": "Sair do grupo",
"description": {
"content": "Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"leave"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Você saiu do grupo.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"leave"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"left\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"leave"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"leave"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"groups",
":id",
"leave"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id do grupo (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Communities",
"description": {
"content": "Comunidades e vínculo de grupos.",
"type": "text/plain"
},
"item": [
{
"name": "Criar comunidade",
"request": {
"name": "Criar comunidade",
"description": {
"content": "O WhatsApp cria o grupo de avisos automaticamente e adiciona `participants` a ele. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\",\n \"participants\": [\n \"5511988887777\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Comunidade criada; `groups[]` traz o grupo de avisos (`is_announcement: true`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\",\n \"participants\": [\n \"5511988887777\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"120363012345678901-group\",\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\",\n \"owner\": \"5511999998888\",\n \"created_at\": \"2026-08-01T10:00:00.000Z\",\n \"participants\": [],\n \"participant_count\": 1,\n \"announce\": false,\n \"locked\": false,\n \"join_approval_required\": false,\n \"member_add_mode\": \"admin_add\",\n \"ephemeral_seconds\": 0,\n \"is_community\": true,\n \"suspended\": false,\n \"groups\": [\n {\n \"id\": \"120363012345678902-group\",\n \"name\": \"Comunidade Wabox\",\n \"is_announcement\": true\n },\n {\n \"id\": \"120363012345678903-group\",\n \"name\": \"Suporte\",\n \"is_announcement\": false\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\",\n \"participants\": [\n \"5511988887777\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\",\n \"participants\": [\n \"5511988887777\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\",\n \"participants\": [\n \"5511988887777\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Listar comunidades",
"request": {
"name": "Listar comunidades",
"description": {
"content": "Comunidades das quais você participa. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Lista de comunidades em `data`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"120363012345678901-group\",\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\",\n \"owner\": \"5511999998888\",\n \"created_at\": \"2026-08-01T10:00:00.000Z\",\n \"participants\": [],\n \"participant_count\": 1,\n \"announce\": false,\n \"locked\": false,\n \"join_approval_required\": false,\n \"member_add_mode\": \"admin_add\",\n \"ephemeral_seconds\": 0,\n \"is_community\": true,\n \"suspended\": false\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Metadados e grupos vinculados",
"request": {
"name": "Metadados e grupos vinculados",
"description": {
"content": "Id da comunidade no formato de grupo: `-group`. `groups[]` lista os grupos vinculados (o grupo de avisos vem com `is_announcement: true`). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Metadados da comunidade com os grupos vinculados.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"120363012345678901-group\",\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\",\n \"owner\": \"5511999998888\",\n \"created_at\": \"2026-08-01T10:00:00.000Z\",\n \"participants\": [],\n \"participant_count\": 1,\n \"announce\": false,\n \"locked\": false,\n \"join_approval_required\": false,\n \"member_add_mode\": \"admin_add\",\n \"ephemeral_seconds\": 0,\n \"is_community\": true,\n \"suspended\": false,\n \"groups\": [\n {\n \"id\": \"120363012345678902-group\",\n \"name\": \"Comunidade Wabox\",\n \"is_announcement\": true\n },\n {\n \"id\": \"120363012345678903-group\",\n \"name\": \"Suporte\",\n \"is_announcement\": false\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Atualizar nome / descrição / foto",
"request": {
"name": "Atualizar nome / descrição / foto",
"description": {
"content": "Mesmo body de `PUT /groups/{id}` (parcial; `remove_picture: true` remove a foto). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Comunidade atualizada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"updated\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Comunidade Wabox\",\n \"description\": \"Nossa comunidade\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Todos os membros da comunidade",
"request": {
"name": "Todos os membros da comunidade",
"description": {
"content": "Telefones dos membros de todos os grupos vinculados (sem repetição). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"participants"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Telefones em `data`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"participants"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n \"5511999998888\",\n \"5511988887777\"\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"participants"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"participants"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"participants"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Vincular grupos existentes à comunidade",
"request": {
"name": "Vincular grupos existentes à comunidade",
"description": {
"content": "Body `{ \"group_ids\": [...] }`. Você precisa ser admin da comunidade e dos grupos. A resposta traz um resultado por grupo (`error` é o status do WhatsApp, por exemplo 403 não permitido). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"group_ids\": [\n \"120363012345678903-group\",\n \"120363012345678904-group\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Um resultado por grupo em `data`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"group_ids\": [\n \"120363012345678903-group\",\n \"120363012345678904-group\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"group_id\": \"120363012345678903-group\",\n \"ok\": true\n },\n {\n \"group_id\": \"120363012345678904-group\",\n \"ok\": false,\n \"error\": \"403\"\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"group_ids\": [\n \"120363012345678903-group\",\n \"120363012345678904-group\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"group_ids\": [\n \"120363012345678903-group\",\n \"120363012345678904-group\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"group_ids\": [\n \"120363012345678903-group\",\n \"120363012345678904-group\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Criar grupo dentro da comunidade",
"request": {
"name": "Criar grupo dentro da comunidade",
"description": {
"content": "Mesmo body de `POST /groups`. O grupo já nasce vinculado, com `parent_id` igual ao id da comunidade. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Suporte\",\n \"participants\": [\n \"5511988887777\",\n \"5511977776666\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Grupo criado (metadados + participantes), vinculado à comunidade.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Suporte\",\n \"participants\": [\n \"5511988887777\",\n \"5511977776666\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"120363012345678903-group\",\n \"name\": \"Suporte\",\n \"description\": \"\",\n \"owner\": \"5511999998888\",\n \"created_at\": \"2026-08-01T10:00:00.000Z\",\n \"participants\": [\n {\n \"phone\": \"5511999998888\",\n \"lid\": \"123456789012345@lid\",\n \"is_admin\": true,\n \"is_super_admin\": true\n },\n {\n \"phone\": \"5511988887777\",\n \"is_admin\": false,\n \"is_super_admin\": false\n }\n ],\n \"participant_count\": 2,\n \"announce\": false,\n \"locked\": false,\n \"join_approval_required\": false,\n \"member_add_mode\": \"all_member_add\",\n \"ephemeral_seconds\": 0,\n \"is_community\": false,\n \"suspended\": false,\n \"parent_id\": \"120363012345678901-group\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Suporte\",\n \"participants\": [\n \"5511988887777\",\n \"5511977776666\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Suporte\",\n \"participants\": [\n \"5511988887777\",\n \"5511977776666\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
"create"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Suporte\",\n \"participants\": [\n \"5511988887777\",\n \"5511977776666\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Desvincular grupos da comunidade",
"request": {
"name": "Desvincular grupos da comunidade",
"description": {
"content": "Body `{ \"group_ids\": [...] }`. Os grupos continuam existindo e só deixam de fazer parte da comunidade. A resposta traz um resultado por grupo. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
"unlink"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"group_ids\": [\n \"120363012345678903-group\",\n \"120363012345678904-group\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Um resultado por grupo em `data`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
"unlink"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"group_ids\": [\n \"120363012345678903-group\",\n \"120363012345678904-group\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"group_id\": \"120363012345678903-group\",\n \"ok\": true\n },\n {\n \"group_id\": \"120363012345678904-group\",\n \"ok\": false,\n \"error\": \"403\"\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
"unlink"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"group_ids\": [\n \"120363012345678903-group\",\n \"120363012345678904-group\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
"unlink"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"group_ids\": [\n \"120363012345678903-group\",\n \"120363012345678904-group\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
"unlink"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"group_ids\": [\n \"120363012345678903-group\",\n \"120363012345678904-group\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Desvincular um grupo da comunidade",
"request": {
"name": "Desvincular um grupo da comunidade",
"description": {
"content": "Atalho para `POST /communities/{id}/groups/unlink` com um único grupo; devolve só o resultado dele. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
":group_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678902-group",
"key": "group_id",
"description": "(Required) Id do grupo vinculado (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Resultado da desvinculação.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
":group_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678902-group",
"key": "group_id",
"description": "(Required) Id do grupo vinculado (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"group_id\": \"120363012345678902-group\",\n \"ok\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
":group_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678902-group",
"key": "group_id",
"description": "(Required) Id do grupo vinculado (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
":group_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678902-group",
"key": "group_id",
"description": "(Required) Id do grupo vinculado (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"groups",
":group_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678902-group",
"key": "group_id",
"description": "(Required) Id do grupo vinculado (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Sair da comunidade",
"request": {
"name": "Sair da comunidade",
"description": {
"content": "Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"leave"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Você saiu da comunidade.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"leave"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"left\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"leave"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"leave"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"communities",
":id",
"leave"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363012345678901-group",
"key": "id",
"description": "(Required) Id da comunidade (`-group`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Newsletters",
"description": {
"content": "Canais (newsletters): criar, seguir, ler e reagir a posts. Para publicar, use qualquer `send-*` com `phone: @newsletter`.",
"type": "text/plain"
},
"item": [
{
"name": "Criar canal",
"request": {
"name": "Criar canal",
"description": {
"content": "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\"`. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Canal Wabox\",\n \"description\": \"Novidades da API\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Canal criado (`role: \"owner\"`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Canal Wabox\",\n \"description\": \"Novidades da API\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"120363999999999999@newsletter\",\n \"name\": \"Canal Wabox\",\n \"description\": \"Novidades da API\",\n \"invite_code\": \"0029VaAbCdEfGhIjKlMn1o\",\n \"invite_url\": \"https://whatsapp.com/channel/0029VaAbCdEfGhIjKlMn1o\",\n \"subscriber_count\": 1234,\n \"verified\": false,\n \"state\": \"active\",\n \"picture_url\": \"https://pps.whatsapp.net/v/t61.24694-24/abc.jpg\",\n \"role\": \"owner\",\n \"muted\": false,\n \"created_at\": \"2026-06-01T10:00:00.000Z\",\n \"reactions_mode\": \"all\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Canal Wabox\",\n \"description\": \"Novidades da API\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Canal Wabox\",\n \"description\": \"Novidades da API\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Canal Wabox\",\n \"description\": \"Novidades da API\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Canais que você possui ou segue",
"request": {
"name": "Canais que você possui ou segue",
"description": {
"content": "`role` indica sua relação com cada canal (`owner`, `admin`, `subscriber`). Para publicar em um canal seu, use qualquer endpoint `send-*` com `phone: \"@newsletter\"`. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Lista de canais em `data`.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"120363999999999999@newsletter\",\n \"name\": \"Canal Wabox\",\n \"description\": \"Novidades da API\",\n \"invite_code\": \"0029VaAbCdEfGhIjKlMn1o\",\n \"invite_url\": \"https://whatsapp.com/channel/0029VaAbCdEfGhIjKlMn1o\",\n \"subscriber_count\": 1234,\n \"verified\": false,\n \"state\": \"active\",\n \"picture_url\": \"https://pps.whatsapp.net/v/t61.24694-24/abc.jpg\",\n \"role\": \"owner\",\n \"muted\": false,\n \"created_at\": \"2026-06-01T10:00:00.000Z\",\n \"reactions_mode\": \"all\"\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Informações do canal pelo link de convite",
"request": {
"name": "Informações do canal pelo link de convite",
"description": {
"content": "`?invite=`. Não segue o canal, só consulta. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
"invite-info"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Metadados do canal (`role: \"guest\"` quando você não o segue).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
"invite-info"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"120363999999999999@newsletter\",\n \"name\": \"Canal Wabox\",\n \"description\": \"Novidades da API\",\n \"invite_code\": \"0029VaAbCdEfGhIjKlMn1o\",\n \"invite_url\": \"https://whatsapp.com/channel/0029VaAbCdEfGhIjKlMn1o\",\n \"subscriber_count\": 1234,\n \"verified\": false,\n \"state\": \"active\",\n \"picture_url\": \"https://pps.whatsapp.net/v/t61.24694-24/abc.jpg\",\n \"role\": \"guest\",\n \"muted\": false,\n \"created_at\": \"2026-06-01T10:00:00.000Z\",\n \"reactions_mode\": \"all\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
"invite-info"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
"invite-info"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
"invite-info"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Metadados do canal",
"request": {
"name": "Metadados do canal",
"description": {
"content": "Id do canal como devolvido pela API / webhooks: `@newsletter`. Para publicar em um canal seu, use qualquer endpoint `send-*` com `phone: \"@newsletter\"`. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Metadados do canal.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"120363999999999999@newsletter\",\n \"name\": \"Canal Wabox\",\n \"description\": \"Novidades da API\",\n \"invite_code\": \"0029VaAbCdEfGhIjKlMn1o\",\n \"invite_url\": \"https://whatsapp.com/channel/0029VaAbCdEfGhIjKlMn1o\",\n \"subscriber_count\": 1234,\n \"verified\": false,\n \"state\": \"active\",\n \"picture_url\": \"https://pps.whatsapp.net/v/t61.24694-24/abc.jpg\",\n \"role\": \"owner\",\n \"muted\": false,\n \"created_at\": \"2026-06-01T10:00:00.000Z\",\n \"reactions_mode\": \"all\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Seguir canal",
"request": {
"name": "Seguir canal",
"description": {
"content": "Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"follow"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Agora você segue o canal.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"follow"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"updated\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"follow"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"follow"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"follow"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Deixar de seguir canal",
"request": {
"name": "Deixar de seguir canal",
"description": {
"content": "Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"unfollow"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Você deixou de seguir o canal.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"unfollow"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"updated\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"unfollow"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"unfollow"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"unfollow"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Silenciar canal",
"request": {
"name": "Silenciar canal",
"description": {
"content": "Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"mute"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Canal silenciado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"mute"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"updated\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"mute"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"mute"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"mute"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Reativar notificações do canal",
"request": {
"name": "Reativar notificações do canal",
"description": {
"content": "Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"unmute"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Canal com notificações reativadas.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"unmute"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"updated\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"unmute"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"unmute"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"unmute"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Publicações recentes",
"request": {
"name": "Publicações recentes",
"description": {
"content": "Retorna metadados e texto das últimas publicações. O Wabox não baixa a mídia, então para publicações de imagem, vídeo ou documento você recebe só o `type` (e o `text`, se houver). `?count=` (máximo 100, padrão 50) e `?before=` paginam para trás. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Publicações em `data`, da mais recente para a mais antiga.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"server_id\": 119,\n \"message_id\": \"3EB0A9C6D2F1E4B5A7F1\",\n \"timestamp\": \"2026-08-19T10:00:00.000Z\",\n \"type\": \"text\",\n \"text\": \"Bem-vindos ao canal!\",\n \"views_count\": 980,\n \"reactions\": {\n \"👍\": 12,\n \"❤️\": 3\n }\n },\n {\n \"server_id\": 118,\n \"message_id\": \"3EB0A9C6D2F1E4B5A7F0\",\n \"timestamp\": \"2026-08-18T10:00:00.000Z\",\n \"type\": \"image\",\n \"views_count\": 1500,\n \"reactions\": {}\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"messages"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Reagir a uma publicação",
"request": {
"name": "Reagir a uma publicação",
"description": {
"content": "Body `{ \"server_id\": 119, \"reaction\": \"👍\" }`. `server_id` vem da listagem de publicações ou do webhook `received`. Reação vazia (`\"\"`) remove a sua. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"server_id\": 119,\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Reação enviada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"server_id\": 119,\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"sent\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"server_id\": 119,\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"server_id\": 119,\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"reaction"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"server_id\": 119,\n \"reaction\": \"👍\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Marcar publicações como vistas",
"request": {
"name": "Marcar publicações como vistas",
"description": {
"content": "Body `{ \"server_ids\": [118, 119] }` (até 100 por chamada). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"read"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"server_ids\": [\n 118,\n 119\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Publicações marcadas como vistas.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"read"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"server_ids\": [\n 118,\n 119\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"read\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"read"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"server_ids\": [\n 118,\n 119\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"read"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"server_ids\": [\n 118,\n 119\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"newsletters",
":id",
"read"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "120363999999999999@newsletter",
"key": "id",
"description": "(Required) Id do canal (`@newsletter`)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"server_ids\": [\n 118,\n 119\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Privacy",
"description": {
"content": "Configurações de privacidade da conta.",
"type": "text/plain"
},
"item": [
{
"name": "Configurações de privacidade atuais",
"request": {
"name": "Configurações de privacidade atuais",
"description": {
"content": "Quem pode ver seu \"visto por último\", online, foto de perfil e recado, as confirmações de leitura, e quem pode adicionar você a grupos, ligar ou enviar mensagem. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Configurações atuais.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"last_seen\": \"contacts\",\n \"online\": \"match_last_seen\",\n \"profile_picture\": \"all\",\n \"about\": \"contacts\",\n \"read_receipts\": \"all\",\n \"groups\": \"contacts\",\n \"calls\": \"all\",\n \"messages\": \"all\",\n \"stickers\": \"contacts\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Alterar uma configuração de privacidade",
"request": {
"name": "Alterar uma configuração de privacidade",
"description": {
"content": "O body é `{ \"value\": ... }`. Valores permitidos: `last_seen`: `all` | `contacts` | `contact_blacklist` | `none`; `online`: `all` | `match_last_seen`; `profile_picture`: `all` | `contacts` | `contact_blacklist` | `none`; `about`: `all` | `contacts` | `contact_blacklist` | `none`; `read_receipts`: `all` | `none`; `groups`: `all` | `contacts` | `contact_blacklist` | `none`; `calls`: `all` | `known`; `messages`: `all` | `contacts`; `stickers`: `contacts` | `contact_allowlist` | `none`. Valor fora da lista responde 400 `invalid_request`. A resposta é o conjunto completo de configurações após a alteração. `disappearing` define o timer padrão de mensagens temporárias para novas conversas (`value` em segundos: 0, 86400, 604800 ou 7776000) e responde `{ \"updated\": true }`. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy",
":setting"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "last_seen",
"key": "setting",
"description": "(Required) Configuração a alterar, ou `disappearing` para o timer padrão de mensagens temporárias."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"contacts\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Configurações após a alteração (ou `{ \"updated\": true }` para `disappearing`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy",
":setting"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "last_seen",
"key": "setting",
"description": "(Required) Configuração a alterar, ou `disappearing` para o timer padrão de mensagens temporárias."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"contacts\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"last_seen\": \"contacts\",\n \"online\": \"match_last_seen\",\n \"profile_picture\": \"all\",\n \"about\": \"contacts\",\n \"read_receipts\": \"all\",\n \"groups\": \"contacts\",\n \"calls\": \"all\",\n \"messages\": \"all\",\n \"stickers\": \"contacts\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "`value` inválido para a configuração.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy",
":setting"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "last_seen",
"key": "setting",
"description": "(Required) Configuração a alterar, ou `disappearing` para o timer padrão de mensagens temporárias."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"contacts\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"invalid_request\",\n \"message\": \"value for last_seen must be one of: all, contacts, contact_blacklist, none\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy",
":setting"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "last_seen",
"key": "setting",
"description": "(Required) Configuração a alterar, ou `disappearing` para o timer padrão de mensagens temporárias."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"contacts\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy",
":setting"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "last_seen",
"key": "setting",
"description": "(Required) Configuração a alterar, ou `disappearing` para o timer padrão de mensagens temporárias."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"contacts\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não está conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"privacy",
":setting"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "last_seen",
"key": "setting",
"description": "(Required) Configuração a alterar, ou `disappearing` para o timer padrão de mensagens temporárias."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"value\": \"contacts\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Business",
"description": {
"content": "Perfil comercial, catálogo de produtos, pedidos e envio de produto/catálogo/pedido. Best effort, depende do protocolo do WhatsApp Web.",
"type": "text/plain"
},
"item": [
{
"name": "Perfil comercial",
"request": {
"name": "Perfil comercial",
"description": {
"content": "Descrição, endereço, e-mail, sites, categorias e horário de funcionamento de uma conta WhatsApp Business. `?phone=` lê o perfil de outro negócio; sem ele, a API devolve o seu. Contas comuns respondem `is_business: false` (os demais campos vêm vazios). Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"profile"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Perfil comercial.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"profile"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"phone\": \"5511966665555\",\n \"is_business\": true,\n \"name\": \"Loja Teste\",\n \"verified_name\": \"Loja Teste LTDA\",\n \"description\": \"Roupas e acessórios\",\n \"address\": \"Rua A, 100 - São Paulo\",\n \"email\": \"contato@loja.test\",\n \"website\": [\n \"https://loja.test\"\n ],\n \"categories\": [\n {\n \"id\": \"133436743388217\",\n \"name\": \"Vestuário\"\n }\n ],\n \"business_hours\": {\n \"timezone\": \"America/Sao_Paulo\",\n \"config\": [\n {\n \"day_of_week\": \"monday\",\n \"mode\": \"specific_hours\",\n \"open_time\": \"09:00\",\n \"close_time\": \"18:00\"\n },\n {\n \"day_of_week\": \"sunday\",\n \"mode\": \"closed\"\n }\n ]\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"profile"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"profile"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"profile"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Atualizar o perfil comercial",
"request": {
"name": "Atualizar o perfil comercial",
"description": {
"content": "Atualização parcial: só os campos enviados mudam (`website: []` / `categories: []` limpam). `business_hours.config[].open_time/close_time` são `HH:MM` no `timezone` informado. Os ids de `categories` são os que aparecem em `categories[].id` de qualquer perfil comercial.\n\n**Best effort.** O WhatsApp não tem API pública de catálogo para dispositivos vinculados. O Wabox fala o mesmo protocolo que o WhatsApp Web usa, e ele pode mudar sem aviso. Escrever no catálogo exige uma conta WhatsApp Business.\n\nExecuta na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"profile"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Roupas e acessórios\",\n \"website\": [\n \"https://loja.test\"\n ],\n \"business_hours\": {\n \"timezone\": \"America/Sao_Paulo\",\n \"config\": [\n {\n \"day_of_week\": \"monday\",\n \"mode\": \"specific_hours\",\n \"open_time\": \"09:00\",\n \"close_time\": \"18:00\"\n },\n {\n \"day_of_week\": \"sunday\",\n \"mode\": \"closed\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Perfil atualizado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"profile"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Roupas e acessórios\",\n \"website\": [\n \"https://loja.test\"\n ],\n \"business_hours\": {\n \"timezone\": \"America/Sao_Paulo\",\n \"config\": [\n {\n \"day_of_week\": \"monday\",\n \"mode\": \"specific_hours\",\n \"open_time\": \"09:00\",\n \"close_time\": \"18:00\"\n },\n {\n \"day_of_week\": \"sunday\",\n \"mode\": \"closed\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"updated\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"profile"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Roupas e acessórios\",\n \"website\": [\n \"https://loja.test\"\n ],\n \"business_hours\": {\n \"timezone\": \"America/Sao_Paulo\",\n \"config\": [\n {\n \"day_of_week\": \"monday\",\n \"mode\": \"specific_hours\",\n \"open_time\": \"09:00\",\n \"close_time\": \"18:00\"\n },\n {\n \"day_of_week\": \"sunday\",\n \"mode\": \"closed\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"profile"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Roupas e acessórios\",\n \"website\": [\n \"https://loja.test\"\n ],\n \"business_hours\": {\n \"timezone\": \"America/Sao_Paulo\",\n \"config\": [\n {\n \"day_of_week\": \"monday\",\n \"mode\": \"specific_hours\",\n \"open_time\": \"09:00\",\n \"close_time\": \"18:00\"\n },\n {\n \"day_of_week\": \"sunday\",\n \"mode\": \"closed\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"profile"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"description\": \"Roupas e acessórios\",\n \"website\": [\n \"https://loja.test\"\n ],\n \"business_hours\": {\n \"timezone\": \"America/Sao_Paulo\",\n \"config\": [\n {\n \"day_of_week\": \"monday\",\n \"mode\": \"specific_hours\",\n \"open_time\": \"09:00\",\n \"close_time\": \"18:00\"\n },\n {\n \"day_of_week\": \"sunday\",\n \"mode\": \"closed\"\n }\n ]\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Listar produtos do catálogo",
"request": {
"name": "Listar produtos do catálogo",
"description": {
"content": "Seu catálogo, ou o de outro negócio com `?phone=`. Pagine com `?limit=` (até 100, padrão 50) e `?cursor=`; quando `next_cursor` não vem na resposta, não há mais páginas. Preços são valores decimais na moeda de `currency` (`79.9` = R$ 79,90).\n\n**Best effort.** O WhatsApp não tem API pública de catálogo para dispositivos vinculados. O Wabox fala o mesmo protocolo que o WhatsApp Web usa, e ele pode mudar sem aviso. Escrever no catálogo exige uma conta WhatsApp Business.\n\nExecuta na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Página de produtos. `next_cursor` só aparece quando há mais páginas.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"6543210987654321\",\n \"name\": \"Camiseta Wabox\",\n \"description\": \"100% algodão\",\n \"price\": 79.9,\n \"currency\": \"BRL\",\n \"retailer_id\": \"SKU-001\",\n \"url\": \"https://wabox.me/loja/camiseta\",\n \"image_url\": \"https://mmg.whatsapp.net/v/t45.5328-4/abc.jpg\",\n \"thumbnail_url\": \"https://mmg.whatsapp.net/v/t45.5328-4/abc_100.jpg\",\n \"hidden\": false,\n \"availability\": \"in stock\",\n \"review_status\": \"approved\"\n }\n ],\n \"next_cursor\": \"eyJwYWdlIjoyfQ==\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Criar um produto",
"request": {
"name": "Criar um produto",
"description": {
"content": "Adiciona um produto ao seu catálogo. A API envia `images` ao WhatsApp (JPEG/PNG, até 10; URL, data URL ou base64). O WhatsApp revisa produtos novos (`review_status`). `price` é decimal na moeda de `currency` (ISO-4217).\n\n**Best effort.** O WhatsApp não tem API pública de catálogo para dispositivos vinculados. O Wabox fala o mesmo protocolo que o WhatsApp Web usa, e ele pode mudar sem aviso. Escrever no catálogo exige uma conta WhatsApp Business.\n\nExecuta na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Camiseta Wabox\",\n \"description\": \"100% algodão\",\n \"price\": 79.9,\n \"currency\": \"BRL\",\n \"retailer_id\": \"SKU-001\",\n \"url\": \"https://wabox.me/loja/camiseta\",\n \"images\": [\n \"https://wabox.me/loja/camiseta.jpg\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Produto criado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Camiseta Wabox\",\n \"description\": \"100% algodão\",\n \"price\": 79.9,\n \"currency\": \"BRL\",\n \"retailer_id\": \"SKU-001\",\n \"url\": \"https://wabox.me/loja/camiseta\",\n \"images\": [\n \"https://wabox.me/loja/camiseta.jpg\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"6543210987654321\",\n \"name\": \"Camiseta Wabox\",\n \"description\": \"100% algodão\",\n \"price\": 79.9,\n \"currency\": \"BRL\",\n \"retailer_id\": \"SKU-001\",\n \"url\": \"https://wabox.me/loja/camiseta\",\n \"image_url\": \"https://mmg.whatsapp.net/v/t45.5328-4/abc.jpg\",\n \"thumbnail_url\": \"https://mmg.whatsapp.net/v/t45.5328-4/abc_100.jpg\",\n \"hidden\": false,\n \"availability\": \"in stock\",\n \"review_status\": \"approved\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Camiseta Wabox\",\n \"description\": \"100% algodão\",\n \"price\": 79.9,\n \"currency\": \"BRL\",\n \"retailer_id\": \"SKU-001\",\n \"url\": \"https://wabox.me/loja/camiseta\",\n \"images\": [\n \"https://wabox.me/loja/camiseta.jpg\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Camiseta Wabox\",\n \"description\": \"100% algodão\",\n \"price\": 79.9,\n \"currency\": \"BRL\",\n \"retailer_id\": \"SKU-001\",\n \"url\": \"https://wabox.me/loja/camiseta\",\n \"images\": [\n \"https://wabox.me/loja/camiseta.jpg\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Camiseta Wabox\",\n \"description\": \"100% algodão\",\n \"price\": 79.9,\n \"currency\": \"BRL\",\n \"retailer_id\": \"SKU-001\",\n \"url\": \"https://wabox.me/loja/camiseta\",\n \"images\": [\n \"https://wabox.me/loja/camiseta.jpg\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Apagar vários produtos",
"request": {
"name": "Apagar vários produtos",
"description": {
"content": "O body é `{ \"product_ids\": [...] }`, com 1 a 50 ids. Responde 404 `product_not_found` se algum id não está no seu catálogo.\n\n**Best effort.** O WhatsApp não tem API pública de catálogo para dispositivos vinculados. O Wabox fala o mesmo protocolo que o WhatsApp Web usa, e ele pode mudar sem aviso. Escrever no catálogo exige uma conta WhatsApp Business.\n\nExecuta na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"product_ids\": [\n \"6543210987654321\",\n \"6543210987654322\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Quantidade de produtos apagados.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {
"mode": "raw",
"raw": "{\n \"product_ids\": [\n \"6543210987654321\",\n \"6543210987654322\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"deleted\": 2\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {
"mode": "raw",
"raw": "{\n \"product_ids\": [\n \"6543210987654321\",\n \"6543210987654322\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {
"mode": "raw",
"raw": "{\n \"product_ids\": [\n \"6543210987654321\",\n \"6543210987654322\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {
"mode": "raw",
"raw": "{\n \"product_ids\": [\n \"6543210987654321\",\n \"6543210987654322\"\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Editar um produto",
"request": {
"name": "Editar um produto",
"description": {
"content": "Atualização parcial; `images` (quando enviado) substitui todas as imagens (`[]` remove todas). Responde 404 `product_not_found` se o produto não está no seu catálogo.\n\n**Best effort.** O WhatsApp não tem API pública de catálogo para dispositivos vinculados. O Wabox fala o mesmo protocolo que o WhatsApp Web usa, e ele pode mudar sem aviso. Escrever no catálogo exige uma conta WhatsApp Business.\n\nExecuta na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "6543210987654321",
"key": "id",
"description": "(Required) Id do produto no WhatsApp (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"price\": 69.9,\n \"hidden\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Produto atualizado.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "6543210987654321",
"key": "id",
"description": "(Required) Id do produto no WhatsApp (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"price\": 69.9,\n \"hidden\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"6543210987654321\",\n \"name\": \"Camiseta Wabox\",\n \"description\": \"100% algodão\",\n \"price\": 69.9,\n \"currency\": \"BRL\",\n \"retailer_id\": \"SKU-001\",\n \"url\": \"https://wabox.me/loja/camiseta\",\n \"image_url\": \"https://mmg.whatsapp.net/v/t45.5328-4/abc.jpg\",\n \"thumbnail_url\": \"https://mmg.whatsapp.net/v/t45.5328-4/abc_100.jpg\",\n \"hidden\": true,\n \"availability\": \"in stock\",\n \"review_status\": \"approved\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "6543210987654321",
"key": "id",
"description": "(Required) Id do produto no WhatsApp (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"price\": 69.9,\n \"hidden\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "6543210987654321",
"key": "id",
"description": "(Required) Id do produto no WhatsApp (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"price\": 69.9,\n \"hidden\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "6543210987654321",
"key": "id",
"description": "(Required) Id do produto no WhatsApp (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"price\": 69.9,\n \"hidden\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Apagar um produto",
"request": {
"name": "Apagar um produto",
"description": {
"content": "Remove o produto do seu catálogo. Responde 404 `product_not_found` se ele não existe.\n\n**Best effort.** O WhatsApp não tem API pública de catálogo para dispositivos vinculados. O Wabox fala o mesmo protocolo que o WhatsApp Web usa, e ele pode mudar sem aviso. Escrever no catálogo exige uma conta WhatsApp Business.\n\nExecuta na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "6543210987654321",
"key": "id",
"description": "(Required) Id do produto no WhatsApp (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Quantidade de produtos apagados.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "6543210987654321",
"key": "id",
"description": "(Required) Id do produto no WhatsApp (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"deleted\": 1\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "6543210987654321",
"key": "id",
"description": "(Required) Id do produto no WhatsApp (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "6543210987654321",
"key": "id",
"description": "(Required) Id do produto no WhatsApp (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"products",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "6543210987654321",
"key": "id",
"description": "(Required) Id do produto no WhatsApp (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Listar coleções do catálogo",
"request": {
"name": "Listar coleções do catálogo",
"description": {
"content": "Coleções, com seus produtos, do seu catálogo ou do de outro negócio (`?phone=`).\n\n**Best effort.** O WhatsApp não tem API pública de catálogo para dispositivos vinculados. O Wabox fala o mesmo protocolo que o WhatsApp Web usa, e ele pode mudar sem aviso. Escrever no catálogo exige uma conta WhatsApp Business.\n\nExecuta na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"collections"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Coleções com seus produtos.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"collections"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"1234567890\",\n \"name\": \"Verão\",\n \"review_status\": \"approved\",\n \"products\": [\n {\n \"id\": \"6543210987654321\",\n \"name\": \"Camiseta Wabox\",\n \"description\": \"100% algodão\",\n \"price\": 79.9,\n \"currency\": \"BRL\",\n \"retailer_id\": \"SKU-001\",\n \"url\": \"https://wabox.me/loja/camiseta\",\n \"image_url\": \"https://mmg.whatsapp.net/v/t45.5328-4/abc.jpg\",\n \"thumbnail_url\": \"https://mmg.whatsapp.net/v/t45.5328-4/abc_100.jpg\",\n \"hidden\": false,\n \"availability\": \"in stock\",\n \"review_status\": \"approved\"\n }\n ]\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"collections"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"collections"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"collections"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Detalhes de um pedido",
"request": {
"name": "Detalhes de um pedido",
"description": {
"content": "Itens e totais de um pedido que um cliente fez a partir do seu catálogo. `id` e `?token=` vêm do bloco `order` do webhook `received`. Responde 404 `order_not_found` se o par id/token não bate.\n\n**Best effort.** O WhatsApp não tem API pública de catálogo para dispositivos vinculados. O Wabox fala o mesmo protocolo que o WhatsApp Web usa, e ele pode mudar sem aviso. Escrever no catálogo exige uma conta WhatsApp Business.\n\nExecuta na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"orders",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1234567890123456",
"key": "id",
"description": "(Required) `order.id` do webhook `received`."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Pedido com itens e totais.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"orders",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1234567890123456",
"key": "id",
"description": "(Required) `order.id` do webhook `received`."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"1234567890123456\",\n \"created_at\": \"2026-08-20T11:58:00.000Z\",\n \"catalog_id\": \"9876543210\",\n \"total\": 159.8,\n \"subtotal\": 159.8,\n \"currency\": \"BRL\",\n \"price_status\": \"confirmed\",\n \"products\": [\n {\n \"id\": \"6543210987654321\",\n \"name\": \"Camiseta Wabox\",\n \"quantity\": 2,\n \"price\": 79.9,\n \"currency\": \"BRL\",\n \"image_url\": \"https://mmg.whatsapp.net/v/t45.5328-4/abc.jpg\",\n \"variant\": \"Tamanho: M\"\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"orders",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1234567890123456",
"key": "id",
"description": "(Required) `order.id` do webhook `received`."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"orders",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1234567890123456",
"key": "id",
"description": "(Required) `order.id` do webhook `received`."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"business",
"orders",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1234567890123456",
"key": "id",
"description": "(Required) `order.id` do webhook `received`."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar card de produto",
"request": {
"name": "Enviar card de produto",
"description": {
"content": "Envia o card de um produto do seu catálogo (ou do catálogo de outro negócio, com `business_phone`), com `message` opcional abaixo. `product_id` pode ser o id do WhatsApp ou o seu `retailer_id`. O engine lê o produto do catálogo na hora do envio. Se ele não existir, o webhook `delivery` chega com erro.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id final no WhatsApp e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-product"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"product_id\": \"6543210987654321\",\n \"message\": \"Olha essa camiseta!\",\n \"footer\": \"Loja Teste\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-product"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"product_id\": \"6543210987654321\",\n \"message\": \"Olha essa camiseta!\",\n \"footer\": \"Loja Teste\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-product"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"product_id\": \"6543210987654321\",\n \"message\": \"Olha essa camiseta!\",\n \"footer\": \"Loja Teste\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-product"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"product_id\": \"6543210987654321\",\n \"message\": \"Olha essa camiseta!\",\n \"footer\": \"Loja Teste\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-product"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"product_id\": \"6543210987654321\",\n \"message\": \"Olha essa camiseta!\",\n \"footer\": \"Loja Teste\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar link do catálogo",
"request": {
"name": "Enviar link do catálogo",
"description": {
"content": "Envia `https://wa.me/c/` (seu próprio catálogo por padrão) com uma `message` opcional acima.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id final no WhatsApp e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-catalog"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Confira nosso catálogo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-catalog"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Confira nosso catálogo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-catalog"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Confira nosso catálogo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-catalog"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Confira nosso catálogo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-catalog"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"message\": \"Confira nosso catálogo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Enviar card de pedido",
"request": {
"name": "Enviar card de pedido",
"description": {
"content": "Envia um card com o resumo de um pedido (`title`, `item_count`, `total`). Os itens só existem em pedidos que o cliente fez a partir do catálogo. Um card criado aqui sem `token` mostra só o resumo. `order_id` é a sua referência (gerada quando omitida); `status` padrão `inquiry`. Para responder a um pedido que o cliente fez, use `order-status-update`.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id final no WhatsApp e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-order"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"order_id\": \"PED-42\",\n \"title\": \"Pedido #42\",\n \"item_count\": 2,\n \"total\": 159.8,\n \"currency\": \"BRL\",\n \"message\": \"Seu pedido foi registrado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-order"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"order_id\": \"PED-42\",\n \"title\": \"Pedido #42\",\n \"item_count\": 2,\n \"total\": 159.8,\n \"currency\": \"BRL\",\n \"message\": \"Seu pedido foi registrado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-order"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"order_id\": \"PED-42\",\n \"title\": \"Pedido #42\",\n \"item_count\": 2,\n \"total\": 159.8,\n \"currency\": \"BRL\",\n \"message\": \"Seu pedido foi registrado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-order"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"order_id\": \"PED-42\",\n \"title\": \"Pedido #42\",\n \"item_count\": 2,\n \"total\": 159.8,\n \"currency\": \"BRL\",\n \"message\": \"Seu pedido foi registrado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"send-order"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"order_id\": \"PED-42\",\n \"title\": \"Pedido #42\",\n \"item_count\": 2,\n \"total\": 159.8,\n \"currency\": \"BRL\",\n \"message\": \"Seu pedido foi registrado.\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Aceitar ou recusar um pedido",
"request": {
"name": "Aceitar ou recusar um pedido",
"description": {
"content": "Responde a um pedido que o cliente fez. Envie o `order_id`, o `token` e o `message_id` da mensagem do pedido como `order_request_message_id` (tudo do bloco `order` do webhook `received`), com `status: accepted | declined`. Use `GET /business/orders/{id}` para ler os itens antes.\n\nA mensagem entra na fila e é enviada de forma assíncrona; `message_id` já é o id final no WhatsApp e o resultado chega no webhook `delivery`. Para usar um id seu (ex.: os ids de uma integração Baileys), envie `custom_message_id`.",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"order-status-update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"order_id\": \"1234567890123456\",\n \"token\": \"AbCdEf0123456789\",\n \"order_request_message_id\": \"3EB0A9C6D2F1E4B5A7E2\",\n \"status\": \"accepted\",\n \"title\": \"Pedido #42\",\n \"item_count\": 2,\n \"total\": 159.8,\n \"currency\": \"BRL\",\n \"message\": \"Pedido confirmado!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Mensagem enfileirada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"order-status-update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"order_id\": \"1234567890123456\",\n \"token\": \"AbCdEf0123456789\",\n \"order_request_message_id\": \"3EB0A9C6D2F1E4B5A7E2\",\n \"status\": \"accepted\",\n \"title\": \"Pedido #42\",\n \"item_count\": 2,\n \"total\": 159.8,\n \"currency\": \"BRL\",\n \"message\": \"Pedido confirmado!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"message_id\": \"3EB0A9C6D2F1E4B5A7C8\",\n \"wabox_id\": \"wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01\",\n \"status\": \"queued\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"order-status-update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"order_id\": \"1234567890123456\",\n \"token\": \"AbCdEf0123456789\",\n \"order_request_message_id\": \"3EB0A9C6D2F1E4B5A7E2\",\n \"status\": \"accepted\",\n \"title\": \"Pedido #42\",\n \"item_count\": 2,\n \"total\": 159.8,\n \"currency\": \"BRL\",\n \"message\": \"Pedido confirmado!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"order-status-update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"order_id\": \"1234567890123456\",\n \"token\": \"AbCdEf0123456789\",\n \"order_request_message_id\": \"3EB0A9C6D2F1E4B5A7E2\",\n \"status\": \"accepted\",\n \"title\": \"Pedido #42\",\n \"item_count\": 2,\n \"total\": 159.8,\n \"currency\": \"BRL\",\n \"message\": \"Pedido confirmado!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada (ações imediatas de perfil, catálogo e pedidos).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"order-status-update"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"phone\": \"5511988887777\",\n \"order_id\": \"1234567890123456\",\n \"token\": \"AbCdEf0123456789\",\n \"order_request_message_id\": \"3EB0A9C6D2F1E4B5A7E2\",\n \"status\": \"accepted\",\n \"title\": \"Pedido #42\",\n \"item_count\": 2,\n \"total\": 159.8,\n \"currency\": \"BRL\",\n \"message\": \"Pedido confirmado!\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Labels",
"description": {
"content": "Etiquetas (labels) de conversas. Só em contas WhatsApp Business.",
"type": "text/plain"
},
"item": [
{
"name": "Listar etiquetas",
"request": {
"name": "Listar etiquetas",
"description": {
"content": "Todas as etiquetas com os chats (telefones / ids de grupo) que as carregam. Etiquetas só existem em contas WhatsApp Business. As mudanças aparecem no celular. A primeira chamada após a instância (re)iniciar dispara uma sincronização das etiquetas com o WhatsApp e pode responder 502 `action_failed` se ela ainda não terminou. Repita em alguns segundos. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Etiquetas e os chats de cada uma.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"1724155200000\",\n \"name\": \"Novo cliente\",\n \"color\": 3,\n \"chats\": [\n \"5511988887777\",\n \"120363012345678901-group\"\n ]\n },\n {\n \"id\": \"2\",\n \"name\": \"Pagamento pendente\",\n \"color\": 7,\n \"chats\": []\n }\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "GET",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Criar uma etiqueta",
"request": {
"name": "Criar uma etiqueta",
"description": {
"content": "O body é `{ \"name\", \"color\" }`. `color` é o índice da paleta dos apps do WhatsApp (0–19; padrão 0). Etiquetas só existem em contas WhatsApp Business. As mudanças aparecem no celular. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Novo cliente\",\n \"color\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Etiqueta criada (ainda sem chats).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Novo cliente\",\n \"color\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"1724155200000\",\n \"name\": \"Novo cliente\",\n \"color\": 3,\n \"chats\": []\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Novo cliente\",\n \"color\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Novo cliente\",\n \"color\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Novo cliente\",\n \"color\": 3\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Renomear ou recolorir uma etiqueta",
"request": {
"name": "Renomear ou recolorir uma etiqueta",
"description": {
"content": "Envie `name`, `color` ou ambos. Responde 404 `label_not_found` se a etiqueta não existe. Etiquetas só existem em contas WhatsApp Business. As mudanças aparecem no celular. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
},
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Cliente novo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Etiqueta atualizada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Cliente novo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"1724155200000\",\n \"name\": \"Cliente novo\",\n \"color\": 3,\n \"chats\": [\n \"5511988887777\",\n \"120363012345678901-group\"\n ]\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Cliente novo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Cliente novo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Cliente novo\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Apagar uma etiqueta",
"request": {
"name": "Apagar uma etiqueta",
"description": {
"content": "Remove a etiqueta de todos os chats. Responde 404 `label_not_found` se ela não existe. Etiquetas só existem em contas WhatsApp Business. As mudanças aparecem no celular. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Etiqueta apagada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"deleted\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Etiquetar um chat",
"request": {
"name": "Etiquetar um chat",
"description": {
"content": "`phone` pode ser um usuário ou um id de grupo. Responde 404 `label_not_found` se a etiqueta não existe. Etiquetas só existem em contas WhatsApp Business. As mudanças aparecem no celular. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone ou id de grupo (`120363012345678901-group`)."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Etiqueta aplicada ao chat.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone ou id de grupo (`120363012345678901-group`)."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"updated\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone ou id de grupo (`120363012345678901-group`)."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone ou id de grupo (`120363012345678901-group`)."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone ou id de grupo (`120363012345678901-group`)."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "PUT",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Tirar a etiqueta de um chat",
"request": {
"name": "Tirar a etiqueta de um chat",
"description": {
"content": "Responde 404 `label_not_found` se a etiqueta não existe. Etiquetas só existem em contas WhatsApp Business. As mudanças aparecem no celular. Executa na hora e exige a instância conectada (caso contrário, 409 `instance_not_connected`).",
"type": "text/plain"
},
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone ou id de grupo (`120363012345678901-group`)."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"auth": {
"type": "noauth"
}
},
"response": [
{
"name": "Etiqueta removida do chat.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone ou id de grupo (`120363012345678901-group`)."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"updated\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância ou token inválidos (`instance_not_found`), ou API key ausente quando o workspace exige uma (`api_key_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone ou id de grupo (`120363012345678901-group`)."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found or invalid token\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Trial expirado ou plano do workspace inativo (`subscription_required`).",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone ou id de grupo (`120363012345678901-group`)."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Payment Required",
"code": 402,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"subscription_required\",\n \"message\": \"Trial expired or subscription inactive. Subscribe in the dashboard to keep sending.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Instância não conectada.",
"originalRequest": {
"url": {
"path": [
"instances",
":instance_id",
"token",
":token",
"chats",
":phone",
"labels",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
},
{
"disabled": false,
"type": "any",
"value": "{{token}}",
"key": "token",
"description": "(Required) Token da instância. Trate como senha."
},
{
"disabled": false,
"type": "any",
"value": "5511988887777",
"key": "phone",
"description": "(Required) Telefone ou id de grupo (`120363012345678901-group`)."
},
{
"disabled": false,
"type": "any",
"value": "1724155200000",
"key": "id",
"description": "(Required) Id da etiqueta (o `id` da listagem)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{api_key}}",
"disabled": true,
"description": "Ative este header se o workspace exigir API key (Segurança)."
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "noauth"
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_connected\",\n \"message\": \"Instance is not connected\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Account",
"description": {
"content": "Account API: criar, atualizar e excluir instâncias da própria conta com uma API key (`Authorization: Bearer wbx_key_…`; base `/account`, sem `instance_id`/`token` na URL). Cada rota pede uma permissão da key (`instances:read`, `instances:write`, `webhooks:read`, `webhooks:write`; sem ela, a resposta é `403 insufficient_scope`). Disponível para contas com plano (conta em trial recebe `403 plan_required`). Cada instância ocupa um slot do plano e, com todos em uso, criar outra responde `409 instance_limit_reached`. Você opera as instâncias pela API pública normal.",
"type": "text/plain"
},
"item": [
{
"name": "Plano e slots da conta",
"request": {
"name": "Plano e slots da conta",
"description": {
"content": "O plano é cobrado por slot (canal), não por instância. Com 5 slots, a conta pode criar, atualizar e excluir instâncias à vontade, desde que não passe de 5 ao mesmo tempo. Excluir uma instância libera o slot na hora.\n\nPermissão da API key: `instances:read`.",
"type": "text/plain"
},
"url": {
"path": [
"account",
"plan"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"response": [
{
"name": "Plano da conta.",
"originalRequest": {
"url": {
"path": [
"account",
"plan"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"subscription_status\": \"active\",\n \"due_at\": \"2026-10-15T12:00:00.000Z\",\n \"instance_slots\": 5,\n \"instances_used\": 3,\n \"instances_available\": 2\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "API key ausente ou inválida (`Authorization: Bearer wbx_key_…`).",
"originalRequest": {
"url": {
"path": [
"account",
"plan"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"api_key_required\",\n \"message\": \"Invalid API key\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "`plan_required` quando a conta está em trial (a Account API exige um plano) ou `insufficient_scope` quando a API key não tem a permissão da rota.",
"originalRequest": {
"url": {
"path": [
"account",
"plan"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"plan_required\",\n \"message\": \"The Account API is available to accounts with a plan. Trial accounts create instances in the dashboard.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Criar instância",
"request": {
"name": "Criar instância",
"description": {
"content": "Cria uma instância na conta e já inicia a sessão. A resposta traz `id`, `token` e `api_url`. Use esses valores na API pública normal para obter o QR (`GET /qr-code`), consultar o status e enviar mensagens. `webhooks` e `settings` são opcionais e aceitam os mesmos campos de `PUT /webhooks` e `PUT /settings`. Cada instância ocupa um slot do plano. Com todos em uso, a resposta é `409 instance_limit_reached`. Exclua uma instância (o slot volta na hora) ou aumente o plano. Veja os slots em `GET /account/plan`.\n\nPermissão da API key: `instances:write`.",
"type": "text/plain"
},
"url": {
"path": [
"account",
"instances"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
},
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Loja Centro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Instância criada.",
"originalRequest": {
"url": {
"path": [
"account",
"instances"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Loja Centro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b\",\n \"name\": \"Loja Centro\",\n \"token\": \"3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E\",\n \"status\": \"qr\",\n \"status_reason\": null,\n \"connected\": false,\n \"phone\": null,\n \"profile_name\": null,\n \"platform\": null,\n \"connected_at\": null,\n \"disconnected_at\": null,\n \"subscription_status\": \"active\",\n \"trial_ends_at\": null,\n \"due_at\": \"2026-10-15T12:00:00.000Z\",\n \"settings\": {\n \"auto_read_message\": false,\n \"auto_read_status\": false,\n \"call_reject_auto\": false,\n \"call_reject_message\": null,\n \"disable_enqueue_when_disconnected\": false,\n \"queue_max_age_hours\": 12,\n \"delay_message_min_ms\": 1000,\n \"delay_message_max_ms\": 3000,\n \"proxy_url\": null,\n \"history_enabled\": true,\n \"always_online\": false\n },\n \"webhooks\": {\n \"received_url\": \"https://app.example/wabox/received\",\n \"delivery_url\": \"https://app.example/wabox/delivery\",\n \"message_status_url\": \"https://app.example/wabox/status\",\n \"instance_status_url\": \"https://app.example/wabox/instance-status\",\n \"chat_presence_url\": null,\n \"notify_sent_by_me\": true,\n \"notify_status\": false,\n \"ignore_groups\": false,\n \"ignore_private\": false,\n \"ignore_text\": false,\n \"ignore_image\": false,\n \"ignore_video\": false,\n \"ignore_audio\": false,\n \"ignore_document\": false,\n \"ignore_received_callback\": false,\n \"ignore_delivery_callback\": false,\n \"ignore_message_status_callback\": false,\n \"ignore_instance_status_callback\": false,\n \"ignore_chat_presence_callback\": false,\n \"secret\": \"whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0\"\n },\n \"api_url\": \"https://api.wabox.me/instances/8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b/token/3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E\",\n \"created_at\": \"2026-09-15T12:00:00.000Z\",\n \"updated_at\": \"2026-09-15T12:00:00.000Z\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "API key ausente ou inválida (`Authorization: Bearer wbx_key_…`).",
"originalRequest": {
"url": {
"path": [
"account",
"instances"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Loja Centro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"api_key_required\",\n \"message\": \"Invalid API key\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "`plan_required` quando a conta está em trial (a Account API exige um plano) ou `insufficient_scope` quando a API key não tem a permissão da rota.",
"originalRequest": {
"url": {
"path": [
"account",
"instances"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Loja Centro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"plan_required\",\n \"message\": \"The Account API is available to accounts with a plan. Trial accounts create instances in the dashboard.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "Todos os slots do plano estão em uso.",
"originalRequest": {
"url": {
"path": [
"account",
"instances"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Loja Centro\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Conflict",
"code": 409,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_limit_reached\",\n \"message\": \"All 5 instance slots of the plan are in use. Delete an instance or add slots to create another.\",\n \"details\": {\n \"instance_slots\": 5,\n \"instances_used\": 5\n }\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Listar instâncias",
"request": {
"name": "Listar instâncias",
"description": {
"content": "Instâncias da conta, da mais recente para a mais antiga, com `token` e webhooks. Filtre por `status` (`connected` / `disconnected`) ou `q` (nome, id ou número).\n\nPermissão da API key: `instances:read`.",
"type": "text/plain"
},
"url": {
"path": [
"account",
"instances"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "status",
"value": "connected"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"response": [
{
"name": "Página de instâncias.",
"originalRequest": {
"url": {
"path": [
"account",
"instances"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "status",
"value": "connected"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b\",\n \"name\": \"Loja Centro\",\n \"token\": \"3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E\",\n \"status\": \"qr\",\n \"status_reason\": null,\n \"connected\": false,\n \"phone\": null,\n \"profile_name\": null,\n \"platform\": null,\n \"connected_at\": null,\n \"disconnected_at\": null,\n \"subscription_status\": \"active\",\n \"trial_ends_at\": null,\n \"due_at\": \"2026-10-15T12:00:00.000Z\",\n \"settings\": {\n \"auto_read_message\": false,\n \"auto_read_status\": false,\n \"call_reject_auto\": false,\n \"call_reject_message\": null,\n \"disable_enqueue_when_disconnected\": false,\n \"queue_max_age_hours\": 12,\n \"delay_message_min_ms\": 1000,\n \"delay_message_max_ms\": 3000,\n \"proxy_url\": null,\n \"history_enabled\": true,\n \"always_online\": false\n },\n \"webhooks\": {\n \"received_url\": \"https://app.example/wabox/received\",\n \"delivery_url\": \"https://app.example/wabox/delivery\",\n \"message_status_url\": \"https://app.example/wabox/status\",\n \"instance_status_url\": \"https://app.example/wabox/instance-status\",\n \"chat_presence_url\": null,\n \"notify_sent_by_me\": true,\n \"notify_status\": false,\n \"ignore_groups\": false,\n \"ignore_private\": false,\n \"ignore_text\": false,\n \"ignore_image\": false,\n \"ignore_video\": false,\n \"ignore_audio\": false,\n \"ignore_document\": false,\n \"ignore_received_callback\": false,\n \"ignore_delivery_callback\": false,\n \"ignore_message_status_callback\": false,\n \"ignore_instance_status_callback\": false,\n \"ignore_chat_presence_callback\": false,\n \"secret\": \"whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0\"\n },\n \"api_url\": \"https://api.wabox.me/instances/8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b/token/3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E\",\n \"created_at\": \"2026-09-15T12:00:00.000Z\",\n \"updated_at\": \"2026-09-15T12:00:00.000Z\"\n }\n ],\n \"page\": 1,\n \"page_size\": 20,\n \"total\": 1\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "API key ausente ou inválida (`Authorization: Bearer wbx_key_…`).",
"originalRequest": {
"url": {
"path": [
"account",
"instances"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "status",
"value": "connected"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"api_key_required\",\n \"message\": \"Invalid API key\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "`plan_required` quando a conta está em trial (a Account API exige um plano) ou `insufficient_scope` quando a API key não tem a permissão da rota.",
"originalRequest": {
"url": {
"path": [
"account",
"instances"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "status",
"value": "connected"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"plan_required\",\n \"message\": \"The Account API is available to accounts with a plan. Trial accounts create instances in the dashboard.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Detalhes da instância",
"request": {
"name": "Detalhes da instância",
"description": {
"content": "Permissão da API key: `instances:read`.",
"type": "text/plain"
},
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"response": [
{
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b\",\n \"name\": \"Loja Centro\",\n \"token\": \"3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E\",\n \"status\": \"qr\",\n \"status_reason\": null,\n \"connected\": false,\n \"phone\": null,\n \"profile_name\": null,\n \"platform\": null,\n \"connected_at\": null,\n \"disconnected_at\": null,\n \"subscription_status\": \"active\",\n \"trial_ends_at\": null,\n \"due_at\": \"2026-10-15T12:00:00.000Z\",\n \"settings\": {\n \"auto_read_message\": false,\n \"auto_read_status\": false,\n \"call_reject_auto\": false,\n \"call_reject_message\": null,\n \"disable_enqueue_when_disconnected\": false,\n \"queue_max_age_hours\": 12,\n \"delay_message_min_ms\": 1000,\n \"delay_message_max_ms\": 3000,\n \"proxy_url\": null,\n \"history_enabled\": true,\n \"always_online\": false\n },\n \"webhooks\": {\n \"received_url\": \"https://app.example/wabox/received\",\n \"delivery_url\": \"https://app.example/wabox/delivery\",\n \"message_status_url\": \"https://app.example/wabox/status\",\n \"instance_status_url\": \"https://app.example/wabox/instance-status\",\n \"chat_presence_url\": null,\n \"notify_sent_by_me\": true,\n \"notify_status\": false,\n \"ignore_groups\": false,\n \"ignore_private\": false,\n \"ignore_text\": false,\n \"ignore_image\": false,\n \"ignore_video\": false,\n \"ignore_audio\": false,\n \"ignore_document\": false,\n \"ignore_received_callback\": false,\n \"ignore_delivery_callback\": false,\n \"ignore_message_status_callback\": false,\n \"ignore_instance_status_callback\": false,\n \"ignore_chat_presence_callback\": false,\n \"secret\": \"whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0\"\n },\n \"api_url\": \"https://api.wabox.me/instances/8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b/token/3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E\",\n \"created_at\": \"2026-09-15T12:00:00.000Z\",\n \"updated_at\": \"2026-09-15T12:00:00.000Z\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "API key ausente ou inválida (`Authorization: Bearer wbx_key_…`).",
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"api_key_required\",\n \"message\": \"Invalid API key\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "`plan_required` quando a conta está em trial (a Account API exige um plano) ou `insufficient_scope` quando a API key não tem a permissão da rota.",
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"plan_required\",\n \"message\": \"The Account API is available to accounts with a plan. Trial accounts create instances in the dashboard.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"instance_not_found\",\n \"message\": \"Instance not found\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Atualizar instância",
"request": {
"name": "Atualizar instância",
"description": {
"content": "Atualização parcial de `name`, `webhooks` e/ou `settings`.\n\nPermissão da API key: `instances:write`.",
"type": "text/plain"
},
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
},
"body": {
"mode": "raw",
"raw": "{\n \"webhooks\": {\n \"received_url\": \"https://app.example/v2/wabox/received\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"webhooks\": {\n \"received_url\": \"https://app.example/v2/wabox/received\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b\",\n \"name\": \"Loja Centro\",\n \"token\": \"3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E\",\n \"status\": \"qr\",\n \"status_reason\": null,\n \"connected\": false,\n \"phone\": null,\n \"profile_name\": null,\n \"platform\": null,\n \"connected_at\": null,\n \"disconnected_at\": null,\n \"subscription_status\": \"active\",\n \"trial_ends_at\": null,\n \"due_at\": \"2026-10-15T12:00:00.000Z\",\n \"settings\": {\n \"auto_read_message\": false,\n \"auto_read_status\": false,\n \"call_reject_auto\": false,\n \"call_reject_message\": null,\n \"disable_enqueue_when_disconnected\": false,\n \"queue_max_age_hours\": 12,\n \"delay_message_min_ms\": 1000,\n \"delay_message_max_ms\": 3000,\n \"proxy_url\": null,\n \"history_enabled\": true,\n \"always_online\": false\n },\n \"webhooks\": {\n \"received_url\": \"https://app.example/wabox/received\",\n \"delivery_url\": \"https://app.example/wabox/delivery\",\n \"message_status_url\": \"https://app.example/wabox/status\",\n \"instance_status_url\": \"https://app.example/wabox/instance-status\",\n \"chat_presence_url\": null,\n \"notify_sent_by_me\": true,\n \"notify_status\": false,\n \"ignore_groups\": false,\n \"ignore_private\": false,\n \"ignore_text\": false,\n \"ignore_image\": false,\n \"ignore_video\": false,\n \"ignore_audio\": false,\n \"ignore_document\": false,\n \"ignore_received_callback\": false,\n \"ignore_delivery_callback\": false,\n \"ignore_message_status_callback\": false,\n \"ignore_instance_status_callback\": false,\n \"ignore_chat_presence_callback\": false,\n \"secret\": \"whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0\"\n },\n \"api_url\": \"https://api.wabox.me/instances/8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b/token/3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E\",\n \"created_at\": \"2026-09-15T12:00:00.000Z\",\n \"updated_at\": \"2026-09-15T12:00:00.000Z\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "API key ausente ou inválida (`Authorization: Bearer wbx_key_…`).",
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"webhooks\": {\n \"received_url\": \"https://app.example/v2/wabox/received\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"api_key_required\",\n \"message\": \"Invalid API key\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "`plan_required` quando a conta está em trial (a Account API exige um plano) ou `insufficient_scope` quando a API key não tem a permissão da rota.",
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"webhooks\": {\n \"received_url\": \"https://app.example/v2/wabox/received\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"plan_required\",\n \"message\": \"The Account API is available to accounts with a plan. Trial accounts create instances in the dashboard.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Excluir instância",
"request": {
"name": "Excluir instância",
"description": {
"content": "Desconecta o número (o aparelho vinculado some do celular), para a sessão e remove a instância. Mensagens na fila são descartadas. O slot fica livre para uma nova instância.\n\nPermissão da API key: `instances:write`.",
"type": "text/plain"
},
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"response": [
{
"name": "Removida.",
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "No Content",
"code": 204,
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"body": "",
"cookie": [],
"_postman_previewlanguage": "text"
},
{
"name": "API key ausente ou inválida (`Authorization: Bearer wbx_key_…`).",
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"api_key_required\",\n \"message\": \"Invalid API key\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "`plan_required` quando a conta está em trial (a Account API exige um plano) ou `insufficient_scope` quando a API key não tem a permissão da rota.",
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"plan_required\",\n \"message\": \"The Account API is available to accounts with a plan. Trial accounts create instances in the dashboard.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Gerar novo token da instância",
"request": {
"name": "Gerar novo token da instância",
"description": {
"content": "O token atual deixa de valer imediatamente.\n\nPermissão da API key: `instances:write`.",
"type": "text/plain"
},
"url": {
"path": [
"account",
"instances",
":instance_id",
"rotate-token"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"response": [
{
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id",
"rotate-token"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"token\": \"7C2E3A1F5C7E9B2D4F6A8C0E1B3D5F7A\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "API key ausente ou inválida (`Authorization: Bearer wbx_key_…`).",
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id",
"rotate-token"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"api_key_required\",\n \"message\": \"Invalid API key\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "`plan_required` quando a conta está em trial (a Account API exige um plano) ou `insufficient_scope` quando a API key não tem a permissão da rota.",
"originalRequest": {
"url": {
"path": [
"account",
"instances",
":instance_id",
"rotate-token"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "{{instance_id}}",
"key": "instance_id",
"description": "(Required) Id da instância (dashboard › instância › Credenciais)."
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"plan_required\",\n \"message\": \"The Account API is available to accounts with a plan. Trial accounts create instances in the dashboard.\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Webhooks do workspace",
"request": {
"name": "Webhooks do workspace",
"description": {
"content": "URLs, filtros e `secret` que toda instância do workspace com `use_workspace_webhooks: true` herda (é o padrão de instância criada sem `webhooks`). Configure uma vez aqui em vez de repetir por instância. O Wabox assina as entregas dessas instâncias com este `secret`, um só para o workspace. `configured: false` indica que a configuração nunca foi salva, então nada é entregue para quem herda. `used_by_instances` é o número de instâncias ativas que herdam agora.\n\nPermissão da API key: `webhooks:read`.",
"type": "text/plain"
},
"url": {
"path": [
"account",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"response": [
{
"name": "Configuração do workspace.",
"originalRequest": {
"url": {
"path": [
"account",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"received_url\": null,\n \"delivery_url\": null,\n \"message_status_url\": null,\n \"instance_status_url\": null,\n \"chat_presence_url\": null,\n \"single_url_enabled\": true,\n \"single_url\": \"https://app.example/wabox/events\",\n \"notify_sent_by_me\": true,\n \"notify_status\": false,\n \"ignore_groups\": false,\n \"ignore_private\": false,\n \"ignore_text\": false,\n \"ignore_image\": false,\n \"ignore_video\": false,\n \"ignore_audio\": false,\n \"ignore_document\": false,\n \"ignore_received_callback\": false,\n \"ignore_delivery_callback\": false,\n \"ignore_message_status_callback\": false,\n \"ignore_instance_status_callback\": false,\n \"ignore_chat_presence_callback\": true,\n \"secret\": \"whsec_4b1d9e8f7a6c5d4e3f2a1b0c9d8e7f6a\",\n \"configured\": true,\n \"used_by_instances\": 42\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "API key ausente ou inválida (`Authorization: Bearer wbx_key_…`).",
"originalRequest": {
"url": {
"path": [
"account",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"api_key_required\",\n \"message\": \"Invalid API key\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Atualizar webhooks do workspace (parcial)",
"request": {
"name": "Atualizar webhooks do workspace (parcial)",
"description": {
"content": "Mesmos campos de `PUT /webhooks` da instância, menos `use_workspace_webhooks`. Só os campos enviados mudam. No primeiro `PUT` o Wabox gera o `secret` do workspace. Guarde-o para verificar `X-Wabox-Signature` das instâncias que herdam. Instâncias com URLs próprias (`use_workspace_webhooks: false`) não são afetadas.\n\nPermissão da API key: `webhooks:write`.",
"type": "text/plain"
},
"url": {
"path": [
"account",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
},
"body": {
"mode": "raw",
"raw": "{\n \"single_url_enabled\": true,\n \"single_url\": \"https://app.example/wabox/events\",\n \"notify_sent_by_me\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"name": "Configuração após a alteração.",
"originalRequest": {
"url": {
"path": [
"account",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"single_url_enabled\": true,\n \"single_url\": \"https://app.example/wabox/events\",\n \"notify_sent_by_me\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"received_url\": null,\n \"delivery_url\": null,\n \"message_status_url\": null,\n \"instance_status_url\": null,\n \"chat_presence_url\": null,\n \"single_url_enabled\": true,\n \"single_url\": \"https://app.example/wabox/events\",\n \"notify_sent_by_me\": true,\n \"notify_status\": false,\n \"ignore_groups\": false,\n \"ignore_private\": false,\n \"ignore_text\": false,\n \"ignore_image\": false,\n \"ignore_video\": false,\n \"ignore_audio\": false,\n \"ignore_document\": false,\n \"ignore_received_callback\": false,\n \"ignore_delivery_callback\": false,\n \"ignore_message_status_callback\": false,\n \"ignore_instance_status_callback\": false,\n \"ignore_chat_presence_callback\": true,\n \"secret\": \"whsec_4b1d9e8f7a6c5d4e3f2a1b0c9d8e7f6a\",\n \"configured\": true,\n \"used_by_instances\": 42\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "API key ausente ou inválida (`Authorization: Bearer wbx_key_…`).",
"originalRequest": {
"url": {
"path": [
"account",
"webhooks"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"single_url_enabled\": true,\n \"single_url\": \"https://app.example/wabox/events\",\n \"notify_sent_by_me\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"api_key_required\",\n \"message\": \"Invalid API key\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"name": "Rotacionar o secret do workspace",
"request": {
"name": "Rotacionar o secret do workspace",
"description": {
"content": "Gera um novo `secret`; o anterior deixa de valer para as próximas entregas de todas as instâncias que herdam. Atualize a verificação no seu servidor antes.\n\nPermissão da API key: `webhooks:write`.",
"type": "text/plain"
},
"url": {
"path": [
"account",
"webhooks",
"secret"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"response": [
{
"name": "Novo secret.",
"originalRequest": {
"url": {
"path": [
"account",
"webhooks",
"secret"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Created",
"code": 201,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"secret\": \"whsec_4b1d9e8f7a6c5d4e3f2a1b0c9d8e7f6a\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"name": "API key ausente ou inválida (`Authorization: Bearer wbx_key_…`).",
"originalRequest": {
"url": {
"path": [
"account",
"webhooks",
"secret"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer "
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_key}}",
"type": "string"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"error\": {\n \"code\": \"api_key_required\",\n \"message\": \"Invalid API key\"\n }\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"name": "Webhooks",
"description": {
"content": "Eventos entregues por `POST` na URL configurada em cada instância.",
"type": "text/plain"
},
"item": [],
"event": []
}
],
"event": [],
"variable": [
{
"key": "baseUrl",
"value": "https://api.wabox.me",
"type": "string"
},
{
"key": "instance_id",
"value": "",
"type": "string"
},
{
"key": "token",
"value": "",
"type": "string"
},
{
"key": "api_key",
"value": "",
"type": "string"
}
],
"info": {
"name": "Wabox API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description": "API pública do Wabox para WhatsApp, com REST e webhooks.\n\nBase: `{server}/instances/{instance_id}/token/{token}`. Quando o workspace exige API key (Segurança), toda chamada também leva `Authorization: Bearer wbx_key_…` de uma key com a permissão `instances:operate`.\n\nTudo em `snake_case`. Datas ISO-8601 (UTC). Erros: `{ \"error\": { \"code\": \"...\", \"message\": \"...\" } }`.\n\nEnvios respondem `{ id, message_id, wabox_id, status: \"queued\" }` na hora; o resultado chega no webhook `delivery`. `message_id` já é o id definitivo do WhatsApp.\n\nDocumentação: https://developer.wabox.me\n\nConfigure baseUrl, instance_id e token nas variáveis de um Environment local. api_key é a API key do workspace (Segurança › API keys): obrigatória na pasta Conta (Account API) e, nas rotas de instância, só quando o workspace exige API key. Comece por Instance → Status. Os exemplos de resposta são ilustrativos. Execute apenas as requisições desejadas: a coleção inclui envios, exclusões e alterações de configuração."
}
}