Newsletters
Get newsletter info
Fetches the metadata of a WhatsApp newsletter/channel by its JID.
Fetches the metadata of a WhatsApp newsletter/channel by its JID.
Authorization
bearerAuth AuthorizationBearer <token>
Per-user API token (UUID v4) sent as Authorization: Bearer <token>. Identifies the tenant and user.
In: header
Path Parameters
jid*string
Newsletter JID.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/newsletters/120363401234567890@newsletter"{ "success": true, "newsletter": { "id": "string", "state": {}, "thread_metadata": { "name": {}, "description": {}, "invite": "string", "subscribers_count": "string", "verification": "string" }, "viewer_metadata": { "mute": "string", "role": "string" } }}{ "success": false, "error": "validation failed", "error_code": "VALIDATION_ERROR", "timestamp": "2026-06-15T12:00:00Z"}{ "success": false, "error": "validation failed", "error_code": "VALIDATION_ERROR", "timestamp": "2026-06-15T12:00:00Z"}{ "success": false, "error": "validation failed", "error_code": "VALIDATION_ERROR", "timestamp": "2026-06-15T12:00:00Z"}{ "success": false, "error": "validation failed", "error_code": "VALIDATION_ERROR", "timestamp": "2026-06-15T12:00:00Z"}Create a newsletter (channel) POST
Creates a new WhatsApp newsletter/channel owned by the connected account. An optional base64-encoded picture sets the channel photo.
Get newsletter invite GET
Returns the invite code and shareable invite link (https://whatsapp.com/channel/<code>) for a WhatsApp newsletter/channel.