{ "openapi": "3.1.0", "info": { "title": "TurbineWhats.app API", "version": "1.1.0", "description": "Independent WhatsApp Web connectivity. Paid group and advanced operations; scoped keys and tenant ownership checks. Read capability limits before integration." }, "servers": [ { "url": "https://turbinewhats.app/api/v1" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "tw_live_" } } }, "paths": { "/channels/{channel_id}/groups": { "get": { "operationId": "get-groups", "summary": "Get all groups for a session", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query" }, { "name": "offset", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query" } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "post": { "operationId": "post-groups", "summary": "Create a new group", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "participants": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "name", "participants" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/chats": { "get": { "operationId": "get-chats", "summary": "Get active chats for a session", "tags": [ "chats" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query" }, { "name": "offset", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query" } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/chats/read": { "post": { "operationId": "post-chats-read", "summary": "Mark a chat as read/seen", "tags": [ "chats" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "messageIds": { "maxItems": 100, "minItems": 1, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "chatId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/presence/subscribe": { "post": { "operationId": "post-presence-subscribe", "summary": "Subscribe to a chat's presence", "tags": [ "presence" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 } }, "required": [ "chatId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/presence": { "put": { "operationId": "put-presence", "summary": "Set the account's own global presence (appear online or offline)", "tags": [ "presence" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "available": { "type": "boolean" } }, "required": [ "available" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/presence/{chatId}": { "get": { "operationId": "get-presence-chatId", "summary": "Read a chat's last reported presence", "tags": [ "presence" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/chats/unread": { "post": { "operationId": "post-chats-unread", "summary": "Mark a chat as unread", "tags": [ "chats" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 } }, "required": [ "chatId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/chats/{chatId}/messages": { "delete": { "operationId": "delete-chats-chatId-messages", "summary": "Delete every message in a chat, keeping the chat itself", "tags": [ "chats" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/chats/archive": { "post": { "operationId": "post-chats-archive", "summary": "Archive or unarchive a chat", "tags": [ "chats" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "archive": { "type": "boolean" } }, "required": [ "chatId", "archive" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/chats/mute": { "post": { "operationId": "post-chats-mute", "summary": "Mute or unmute a chat", "tags": [ "chats" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "muteUntil": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": [ "chatId", "muteUntil" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/chats/pin": { "post": { "operationId": "post-chats-pin", "summary": "Pin or unpin a chat at the top of the chat list", "tags": [ "chats" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "pin": { "type": "boolean" } }, "required": [ "chatId", "pin" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/chats/delete": { "post": { "operationId": "post-chats-delete", "summary": "Delete a chat from the chat list (e.g. a group you have left)", "tags": [ "chats" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 } }, "required": [ "chatId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/chats/typing": { "post": { "operationId": "post-chats-typing", "summary": "Send a typing/recording presence indicator to a chat (or clear it with 'paused')", "tags": [ "chats" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "state": { "type": "string", "enum": [ "typing", "recording", "paused" ], "maxLength": 4096 } }, "required": [ "chatId", "state" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages": { "get": { "operationId": "get-messages", "summary": "Get message history for a session", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatId", "required": false, "schema": { "type": "string", "maxLength": 4096 }, "in": "query" }, { "name": "from", "required": false, "schema": { "type": "string", "maxLength": 4096 }, "in": "query" }, { "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query" }, { "name": "offset", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query" }, { "name": "after", "required": false, "schema": { "type": "string", "maxLength": 4096 }, "in": "query" }, { "name": "inlineMedia", "required": false, "schema": { "type": "boolean" }, "in": "query" }, { "name": "since", "required": false, "schema": { "type": "number" }, "in": "query" }, { "name": "until", "required": false, "schema": { "type": "number" }, "in": "query" }, { "name": "direction", "required": false, "schema": { "enum": [ "incoming", "outgoing" ], "type": "string", "maxLength": 4096 }, "in": "query" }, { "name": "orderBy", "required": false, "schema": { "enum": [ "createdAt", "timestamp" ], "type": "string", "maxLength": 4096 }, "in": "query" }, { "name": "type", "required": false, "schema": { "type": "string", "maxLength": 4096 }, "in": "query" }, { "name": "messageId", "required": false, "schema": { "type": "string", "maxLength": 4096 }, "in": "query" } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/send-text": { "post": { "operationId": "post-messages-send-text", "summary": "Send a text message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "text": { "type": "string", "maxLength": 4096 }, "mentions": { "maxItems": 100, "items": { "type": "string", "maxLength": 64 }, "type": "array" }, "linkPreview": { "type": "boolean", "enum": [ false ] }, "quotedMessageId": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId", "text" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/send-image": { "post": { "operationId": "post-messages-send-image", "summary": "Send an image message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "url": { "type": "string", "maxLength": 2048 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "maxLength": 4096 }, "filename": { "type": "string", "maxLength": 255 }, "caption": { "type": "string", "maxLength": 1024 }, "mentions": { "maxItems": 100, "items": { "type": "string", "maxLength": 64 }, "type": "array" }, "quotedMessageId": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/send-video": { "post": { "operationId": "post-messages-send-video", "summary": "Send a video message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "url": { "type": "string", "maxLength": 2048 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "maxLength": 4096 }, "filename": { "type": "string", "maxLength": 255 }, "caption": { "type": "string", "maxLength": 1024 }, "mentions": { "maxItems": 100, "items": { "type": "string", "maxLength": 64 }, "type": "array" }, "quotedMessageId": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/send-audio": { "post": { "operationId": "post-messages-send-audio", "summary": "Send an audio/voice message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "url": { "type": "string", "maxLength": 2048 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "maxLength": 4096 }, "filename": { "type": "string", "maxLength": 255 }, "caption": { "type": "string", "maxLength": 1024 }, "mentions": { "maxItems": 100, "items": { "type": "string", "maxLength": 64 }, "type": "array" }, "quotedMessageId": { "type": "string", "maxLength": 4096 }, "ptt": { "type": "boolean" } }, "required": [ "chatId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/send-document": { "post": { "operationId": "post-messages-send-document", "summary": "Send a document/file", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "url": { "type": "string", "maxLength": 2048 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "maxLength": 4096 }, "filename": { "type": "string", "maxLength": 255 }, "caption": { "type": "string", "maxLength": 1024 }, "mentions": { "maxItems": 100, "items": { "type": "string", "maxLength": 64 }, "type": "array" }, "quotedMessageId": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/send-location": { "post": { "operationId": "post-messages-send-location", "summary": "Send a location message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "description": { "type": "string", "maxLength": 1024 }, "address": { "type": "string", "maxLength": 1024 }, "quotedMessageId": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId", "latitude", "longitude" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/send-contact": { "post": { "operationId": "post-messages-send-contact", "summary": "Send a contact card message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "contactName": { "type": "string", "maxLength": 255 }, "contactNumber": { "type": "string", "maxLength": 30 }, "quotedMessageId": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId", "contactName", "contactNumber" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/send-sticker": { "post": { "operationId": "post-messages-send-sticker", "summary": "Send a sticker message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "url": { "type": "string", "maxLength": 2048 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "maxLength": 4096 }, "filename": { "type": "string", "maxLength": 255 }, "caption": { "type": "string", "maxLength": 1024 }, "mentions": { "maxItems": 100, "items": { "type": "string", "maxLength": 64 }, "type": "array" }, "quotedMessageId": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/send-poll": { "post": { "operationId": "post-messages-send-poll", "summary": "Send a native WhatsApp poll", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "name": { "type": "string", "maxLength": 255 }, "options": { "minItems": 2, "maxItems": 12, "items": { "type": "string", "maxLength": 100 }, "type": "array" }, "allowMultipleAnswers": { "type": "boolean" }, "quotedMessageId": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId", "name", "options" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/reply": { "post": { "operationId": "post-messages-reply", "summary": "Reply to a message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "quotedMessageId": { "type": "string", "maxLength": 4096 }, "text": { "type": "string", "maxLength": 4096 }, "mentions": { "maxItems": 100, "items": { "type": "string", "maxLength": 64 }, "type": "array" } }, "required": [ "chatId", "quotedMessageId", "text" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/click-button": { "post": { "operationId": "post-messages-click-button", "summary": "Click a button on a WhatsApp Business prompt (Baileys only)", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "messageId": { "type": "string", "maxLength": 4096 }, "buttonId": { "type": "string", "maxLength": 256 }, "text": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId", "messageId", "buttonId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/forward": { "post": { "operationId": "post-messages-forward", "summary": "Forward a message to another chat", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromChatId": { "type": "string", "maxLength": 255 }, "toChatId": { "type": "string", "maxLength": 255 }, "messageId": { "type": "string", "maxLength": 4096 } }, "required": [ "fromChatId", "toChatId", "messageId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/react": { "post": { "operationId": "post-messages-react", "summary": "Add or remove a reaction to a message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "messageId": { "type": "string", "maxLength": 4096 }, "emoji": { "type": "string", "maxLength": 32 } }, "required": [ "chatId", "messageId", "emoji" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/{chatId}/history": { "get": { "operationId": "get-messages-chatId-history", "summary": "Fetch chat history live from WhatsApp", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query" }, { "name": "includeMedia", "required": false, "schema": { "type": "boolean" }, "in": "query" }, { "name": "deep", "required": false, "schema": { "type": "boolean" }, "in": "query" } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/{chatId}/{messageId}/reactions": { "get": { "operationId": "get-messages-chatId-messageId-reactions", "summary": "Get reactions for a specific message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/{chatId}/{messageId}/receipts": { "get": { "operationId": "get-messages-chatId-messageId-receipts", "summary": "Get delivery and read receipts for a specific message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/{chatId}/{messageId}/media": { "get": { "operationId": "get-messages-chatId-messageId-media", "summary": "Download a message’s stored media", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/delete": { "post": { "operationId": "post-messages-delete", "summary": "Delete a message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "messageId": { "type": "string", "maxLength": 4096 }, "forEveryone": { "type": "boolean" } }, "required": [ "chatId", "messageId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/vote-poll": { "post": { "operationId": "post-messages-vote-poll", "summary": "Cast a vote on a poll", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "pollMessageId": { "type": "string", "maxLength": 4096 }, "options": { "maxItems": 12, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "chatId", "pollMessageId", "options" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/pin": { "post": { "operationId": "post-messages-pin", "summary": "Pin a message in its chat", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "messageId": { "type": "string", "maxLength": 4096 }, "durationSeconds": { "type": "number", "enum": [ 86400, 604800, 2592000 ] } }, "required": [ "chatId", "messageId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/unpin": { "post": { "operationId": "post-messages-unpin", "summary": "Remove a message’s pin", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "messageId": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId", "messageId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/star": { "post": { "operationId": "post-messages-star", "summary": "Star or unstar a message", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "messageId": { "type": "string", "maxLength": 4096 }, "star": { "type": "boolean" } }, "required": [ "chatId", "messageId", "star" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/edit": { "post": { "operationId": "post-messages-edit", "summary": "Edit the text of a message sent by this account", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "messageId": { "type": "string", "maxLength": 4096 }, "body": { "type": "string", "maxLength": 4096 }, "mentions": { "maxItems": 100, "items": { "type": "string", "maxLength": 64 }, "type": "array" } }, "required": [ "chatId", "messageId", "body" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/contacts": { "get": { "operationId": "get-contacts", "summary": "Get all contacts for a session", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query" }, { "name": "offset", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query" } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/contacts/profile-pictures": { "get": { "operationId": "get-contacts-profile-pictures", "summary": "Batch-resolve profile picture URLs for up to 50 contacts", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ids", "required": false, "schema": { "type": "string", "maxLength": 4096 }, "in": "query" } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/contacts/blocked": { "get": { "operationId": "get-contacts-blocked", "summary": "List the contacts this account has blocked", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/contacts/{contactId}": { "get": { "operationId": "get-contacts-contactId", "summary": "Get a specific contact by ID", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "put": { "operationId": "put-contacts-contactId", "summary": "Save a contact to the account's addressbook, or edit an existing entry", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 100 }, "lastName": { "type": "string", "maxLength": 100 } }, "required": [ "firstName" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "delete": { "operationId": "delete-contacts-contactId", "summary": "Remove a contact from the account's addressbook", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/contacts/check/{number}": { "get": { "operationId": "get-contacts-check-number", "summary": "Check if a phone number exists on WhatsApp", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "number", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/contacts/{number}/lid": { "get": { "operationId": "get-contacts-number-lid", "summary": "Look up the LID of a phone number", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "number", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/contacts/{contactId}/profile-picture": { "get": { "operationId": "get-contacts-contactId-profile-picture", "summary": "Get profile picture URL for a contact", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/contacts/{contactId}/phone": { "get": { "operationId": "get-contacts-contactId-phone", "summary": "Resolve a contact id (e.g. an @lid) to a phone number — best-effort", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/contacts/{contactId}/block": { "post": { "operationId": "post-contacts-contactId-block", "summary": "Block a contact", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "delete": { "operationId": "delete-contacts-contactId-block", "summary": "Unblock a contact", "tags": [ "contacts" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/join-info": { "get": { "operationId": "get-groups-join-info", "summary": "Preview a group from its invite code, without joining", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "code", "required": true, "schema": { "type": "string", "maxLength": 4096 }, "in": "query" } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}": { "get": { "operationId": "get-groups-groupId", "summary": "Get detailed group info", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/join": { "post": { "operationId": "post-groups-join", "summary": "Join a group via invite code", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inviteCode": { "type": "string", "maxLength": 128 } }, "required": [ "inviteCode" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/settings": { "get": { "operationId": "get-groups-groupId-settings", "summary": "Get group settings (announce / locked / ephemeral timer / member-add mode)", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "put": { "operationId": "put-groups-groupId-settings", "summary": "Update group settings (announce / locked / ephemeral timer / member-add mode)", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "announce": { "type": "boolean" }, "locked": { "type": "boolean" }, "ephemeralSeconds": { "type": "number", "minimum": 0 }, "memberAddMode": { "type": "string", "enum": [ "all", "admins" ], "maxLength": 4096 } }, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/participants": { "post": { "operationId": "post-groups-groupId-participants", "summary": "Add participants to a group", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "participants": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "participants" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "delete": { "operationId": "delete-groups-groupId-participants", "summary": "Remove participants from a group", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "participants": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "participants" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/participants/promote": { "post": { "operationId": "post-groups-groupId-participants-promote", "summary": "Promote participants to admin", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "participants": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "participants" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/participants/demote": { "post": { "operationId": "post-groups-groupId-participants-demote", "summary": "Demote participants from admin", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "participants": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "participants" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/membership-requests": { "get": { "operationId": "get-groups-groupId-membership-requests", "summary": "List pending join requests for a group", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/membership-requests/approve": { "post": { "operationId": "post-groups-groupId-membership-requests-approve", "summary": "Approve pending join requests", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "participants": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/membership-requests/reject": { "post": { "operationId": "post-groups-groupId-membership-requests-reject", "summary": "Reject pending join requests", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "participants": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/subject": { "put": { "operationId": "put-groups-groupId-subject", "summary": "Change group name/subject", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string", "maxLength": 100 } }, "required": [ "subject" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/description": { "put": { "operationId": "put-groups-groupId-description", "summary": "Change group description", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 1024 } }, "required": [ "description" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/member-label": { "put": { "operationId": "put-groups-groupId-member-label", "summary": "Set this account's member label in a group", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 30 } }, "required": [ "label" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/leave": { "post": { "operationId": "post-groups-groupId-leave", "summary": "Leave a group", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/picture": { "get": { "operationId": "get-groups-groupId-picture", "summary": "Get the group's picture URL", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "put": { "operationId": "put-groups-groupId-picture", "summary": "Set the group's picture", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "maxLength": 4096 } }, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "delete": { "operationId": "delete-groups-groupId-picture", "summary": "Remove the group's picture", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/invite-code": { "get": { "operationId": "get-groups-groupId-invite-code", "summary": "Get group invite code/link", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/groups/{groupId}/invite-code/revoke": { "post": { "operationId": "post-groups-groupId-invite-code-revoke", "summary": "Revoke group invite code and generate new one", "tags": [ "groups" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/profile/name": { "put": { "operationId": "put-profile-name", "summary": "Set the account display name", "tags": [ "profile" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 25 } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/profile/status": { "put": { "operationId": "put-profile-status", "summary": "Set the account about/status text", "tags": [ "profile" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "maxLength": 139 } }, "required": [ "status" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/profile/picture": { "put": { "operationId": "put-profile-picture", "summary": "Set the account profile picture (URL or base64 image)", "tags": [ "profile" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "maxLength": 4096 } }, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "delete": { "operationId": "delete-profile-picture", "summary": "Remove the account's profile picture", "tags": [ "profile" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/calls/link": { "post": { "operationId": "post-calls-link", "summary": "Generate a shareable WhatsApp call link", "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "audio", "video" ], "maxLength": 4096 }, "startTime": { "type": "integer", "minimum": 1, "maximum": 8640000000000000 } }, "required": [ "type", "startTime" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/calls/{callId}/reject": { "post": { "operationId": "post-calls-callId-reject", "summary": "Reject a ringing incoming call", "tags": [ "calls" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "callId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/labels": { "get": { "operationId": "get-labels", "summary": "Get all labels (WhatsApp Business only)", "tags": [ "labels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/labels/{labelId}": { "get": { "operationId": "get-labels-labelId", "summary": "Get a specific label by ID", "tags": [ "labels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "put": { "operationId": "put-labels-labelId", "summary": "Create or update a label", "tags": [ "labels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "type": "number", "minimum": 0, "maximum": 19 } }, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "delete": { "operationId": "delete-labels-labelId", "summary": "Delete a label", "tags": [ "labels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/labels/{labelId}/chats": { "get": { "operationId": "get-labels-labelId-chats", "summary": "Get every chat carrying a label", "tags": [ "labels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/labels/chat/{chatId}": { "get": { "operationId": "get-labels-chat-chatId", "summary": "Get labels for a specific chat", "tags": [ "labels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "post": { "operationId": "post-labels-chat-chatId", "summary": "Add a label to a chat", "tags": [ "labels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "labelId": { "type": "string", "maxLength": 4096 } }, "required": [ "labelId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/labels/chat/{chatId}/{labelId}": { "delete": { "operationId": "delete-labels-chat-chatId-labelId", "summary": "Remove a label from a chat", "tags": [ "labels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chatId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "labelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/channels": { "get": { "operationId": "get-channels", "summary": "Get all subscribed channels/newsletters", "tags": [ "channels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "post": { "operationId": "post-channels", "summary": "Create a channel", "tags": [ "channels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2048 } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/channels/{channelId}": { "get": { "operationId": "get-channels-channelId", "summary": "Get a specific channel by ID", "tags": [ "channels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "delete": { "operationId": "delete-channels-channelId", "summary": "Unsubscribe from a channel", "tags": [ "channels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/channels/{channelId}/messages": { "get": { "operationId": "get-channels-channelId-messages", "summary": "Get messages from a channel", "tags": [ "channels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query" } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/channels/{channelId}/delete": { "post": { "operationId": "post-channels-channelId-delete", "summary": "Delete a channel this account owns", "tags": [ "channels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/channels/{channelId}/mute": { "post": { "operationId": "post-channels-channelId-mute", "summary": "Mute or unmute a channel", "tags": [ "channels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mute": { "type": "boolean" } }, "required": [ "mute" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/channels/{channelId}/admins/demote": { "post": { "operationId": "post-channels-channelId-admins-demote", "summary": "Demote a channel admin back to a subscriber", "tags": [ "channels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "maxLength": 4096 } }, "required": [ "userId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/channels/{channelId}/owner/transfer": { "post": { "operationId": "post-channels-channelId-owner-transfer", "summary": "Transfer channel ownership to another account", "tags": [ "channels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "newOwnerId": { "type": "string", "maxLength": 4096 } }, "required": [ "newOwnerId" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/channels/subscribe": { "post": { "operationId": "post-channels-subscribe", "summary": "Subscribe to a channel using invite code", "tags": [ "channels" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "inviteCode": { "type": "string", "maxLength": 4096 } }, "required": [ "inviteCode" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/stories": { "get": { "operationId": "get-stories", "summary": "Get all contact status updates", "tags": [ "stories" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/stories/{id}": { "get": { "operationId": "get-stories-id", "summary": "Get status updates from a specific contact", "tags": [ "stories" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "delete": { "operationId": "delete-stories-id", "summary": "Delete own status", "tags": [ "stories" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Idempotent management operation; an unconfirmed result is marked uncertain and is not retried automatically.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false, "required": [] } } } }, "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/stories/{statusId}/media": { "get": { "operationId": "get-stories-statusId-media", "summary": "Stream a stored status media file", "tags": [ "stories" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "statusId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/stories/send-text": { "post": { "operationId": "post-stories-send-text", "summary": "Post a text status", "tags": [ "stories" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 4096 }, "backgroundColor": { "type": "string", "maxLength": 4096 }, "font": { "type": "number", "enum": [ 0, 1, 2, 6, 7, 8, 9, 10 ] }, "recipients": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "text" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/stories/send-image": { "post": { "operationId": "post-stories-send-image", "summary": "Post an image status", "tags": [ "stories" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "image": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "maxLength": 4096 } }, "required": [], "additionalProperties": false }, "caption": { "type": "string", "maxLength": 1024 }, "recipients": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "image" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/stories/send-video": { "post": { "operationId": "post-stories-send-video", "summary": "Post a video status", "tags": [ "stories" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "video": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "maxLength": 4096 } }, "required": [], "additionalProperties": false }, "caption": { "type": "string", "maxLength": 1024 }, "recipients": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "video" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/stories/send-voice": { "post": { "operationId": "post-stories-send-voice", "summary": "Post an audio status as a voice note", "tags": [ "stories" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "audio": { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "maxLength": 4096 } }, "required": [], "additionalProperties": false }, "backgroundColor": { "type": "string", "maxLength": 4096 }, "recipients": { "maxItems": 100, "type": "array", "items": { "type": "string", "maxLength": 4096 } } }, "required": [ "audio" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/catalog": { "get": { "operationId": "get-catalog", "summary": "Get business catalog info (Baileys engine only)", "tags": [ "catalog" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/catalog/products": { "get": { "operationId": "get-catalog-products", "summary": "List catalog products (Baileys engine only)", "tags": [ "catalog" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "required": false, "schema": { "minimum": 1, "type": "integer" }, "in": "query" }, { "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query" } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/catalog/products/{productId}": { "get": { "operationId": "get-catalog-products-productId", "summary": "Get a specific product (Baileys engine only)", "tags": [ "catalog" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Read-only request.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Result under the data envelope.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/messages/send-product": { "post": { "operationId": "post-messages-send-product", "summary": "Send a product message (Baileys engine only)", "tags": [ "messages" ], "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "x-paid-only": true, "description": "Ready owned session required. Engine-specific support and WhatsApp account permissions apply. Mutation is durably queued and counts toward the account message allowance.", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatId": { "type": "string", "maxLength": 255 }, "productId": { "type": "string", "maxLength": 255 }, "body": { "type": "string", "maxLength": 4096 } }, "required": [ "chatId", "productId" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Queued message; not a delivery confirmation.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object" } } } } } }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels": { "get": { "summary": "List sessions owned by your account and allowed by this key.", "operationId": "legacy-get--channels", "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "description": "Request and response details: https://turbinewhats.app/docs/sessions", "parameters": [], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } }, "post": { "summary": "Create a session and queue its preparation. An account-wide management key is required.", "operationId": "legacy-post--channels", "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "description": "Request and response details: https://turbinewhats.app/docs/sessions", "parameters": [], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 80 } } } } } } } }, "/channels/{channel_id}/status": { "get": { "summary": "Refresh the session state from the gateway.", "operationId": "legacy-get--channels-channel-id-status", "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "description": "Request and response details: https://turbinewhats.app/docs/sessions", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/qr": { "get": { "summary": "Retrieve the pairing QR code after session preparation.", "operationId": "legacy-get--channels-channel-id-qr", "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "description": "Request and response details: https://turbinewhats.app/docs/sessions", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/start": { "post": { "summary": "Start an existing session. Pairing may be required.", "operationId": "legacy-post--channels-channel-id-start", "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "description": "Request and response details: https://turbinewhats.app/docs/sessions", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/stop": { "post": { "summary": "Queue a stop operation for the session.", "operationId": "legacy-post--channels-channel-id-stop", "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "description": "Request and response details: https://turbinewhats.app/docs/sessions", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/channels/{channel_id}/delete": { "post": { "summary": "Queue session deletion and logout. This does not cancel billing.", "operationId": "legacy-post--channels-channel-id-delete", "security": [ { "bearerAuth": [] } ], "x-required-scope": "manage", "description": "Request and response details: https://turbinewhats.app/docs/sessions", "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/messages/text": { "post": { "summary": "Queue a text message with an idempotency key.", "operationId": "legacy-post--messages-text", "security": [ { "bearerAuth": [] } ], "x-required-scope": "send", "description": "Request and response details: https://turbinewhats.app/docs/messages", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "channel_id", "to", "body" ], "properties": { "channel_id": { "type": "string", "format": "uuid" }, "to": { "type": "string", "description": "International phone number, or a group ID on paid access." }, "body": { "type": "string", "minLength": 1, "maxLength": 4096 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "enum": [ "image/jpeg", "image/png", "application/pdf" ] }, "filename": { "type": "string", "maxLength": 120, "pattern": "^[\\w .-]+$" }, "caption": { "type": "string", "maxLength": 1024 } } } } } } } }, "/messages/image": { "post": { "summary": "Queue a JPEG or PNG provided as base64.", "operationId": "legacy-post--messages-image", "security": [ { "bearerAuth": [] } ], "x-required-scope": "send · paid", "description": "Request and response details: https://turbinewhats.app/docs/media", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "channel_id", "to", "base64", "mimetype" ], "properties": { "channel_id": { "type": "string", "format": "uuid" }, "to": { "type": "string", "description": "International phone number, or a group ID on paid access." }, "body": { "type": "string", "minLength": 1, "maxLength": 4096 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "enum": [ "image/jpeg", "image/png", "application/pdf" ] }, "filename": { "type": "string", "maxLength": 120, "pattern": "^[\\w .-]+$" }, "caption": { "type": "string", "maxLength": 1024 } } } } } } } }, "/messages/document": { "post": { "summary": "Queue a PDF document provided as base64.", "operationId": "legacy-post--messages-document", "security": [ { "bearerAuth": [] } ], "x-required-scope": "send · paid", "description": "Request and response details: https://turbinewhats.app/docs/media", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } } ], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "channel_id", "to", "base64", "mimetype" ], "properties": { "channel_id": { "type": "string", "format": "uuid" }, "to": { "type": "string", "description": "International phone number, or a group ID on paid access." }, "body": { "type": "string", "minLength": 1, "maxLength": 4096 }, "base64": { "type": "string", "maxLength": 1400000, "pattern": "^[A-Za-z0-9+/]+={0,2}$" }, "mimetype": { "type": "string", "enum": [ "image/jpeg", "image/png", "application/pdf" ] }, "filename": { "type": "string", "maxLength": 120, "pattern": "^[\\w .-]+$" }, "caption": { "type": "string", "maxLength": 1024 } } } } } } } }, "/messages/{id}": { "get": { "summary": "Read a message state using its TurbineWhats.app message ID.", "operationId": "legacy-get--messages-id-", "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "description": "Request and response details: https://turbinewhats.app/docs/delivery", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response under data. Sends return HTTP 202." }, "202": { "description": "Queued; not a delivery confirmation." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } }, "/operations/{id}": { "get": { "summary": "Read a recorded management operation", "security": [ { "bearerAuth": [] } ], "x-required-scope": "read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Own operation state and retained result." }, "default": { "description": "Request rejected, unauthorized, rate limited, unsupported by the active engine, or unavailable.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } } } } } }