TokenAccount or TokenInstance on every route. Each call validates the instance ownership.
This section covers the /api/newsletter/* routes for creating channels, listing subscriptions, getting details, following, and unfollowing. Channels have JIDs ending in @newsletter (different from group @g.us JIDs).
Endpoints
| Method | Path | Function |
|---|---|---|
| POST | /api/newsletter/create/:instance | Create channel |
| GET | /api/newsletter/list/:instance | List subscribed channels |
| GET | /api/newsletter/info/:instance | Channel info |
| POST | /api/newsletter/join/:instance | Subscribe |
| DELETE | /api/newsletter/leave/:instance | Unsubscribe |
Accepted identifiers
Theinfo, join, and leave endpoints accept:
| Form | Example |
|---|---|
| JID | 120363422585881117@newsletter |
| Full link | https://whatsapp.com/channel/120363422585881117 |
| Code only | 120363422585881117 |
NewsletterChannel model
| Field | Type | Description |
|---|---|---|
jid | string | <id>@newsletter |
state | string | active, suspended, geosuspended |
name | string | Channel name |
description | string | May be empty |
inviteLink | string? | https://whatsapp.com/channel/<id> (admins / creator only) |
subscriberCount | int | May be 0 if unknown |
pictureUrl | string? | Temporary URL from WhatsApp’s CDN |
Channel states
| State | Meaning |
|---|---|
active | Operational channel, accepting posts and new followers |
suspended | Channel suspended (policy violation), visible but no interaction |
geosuspended | Channel unavailable in your region |
Error envelope
WhatsMeow client support
Error reference (summary)
| HTTP | Message |
|---|---|
| 400 | The 'name' field is required |
| 400 | The 'identifier' query parameter is required (JID @newsletter or invite link/code) |
| 400 | Invalid newsletter identifier (use JID @newsletter or invite link/code) |
| 400 | Instance is not connected to WhatsApp |
| 404 | newsletter not found |
| 500 | failed to create newsletter: <reason> |
| 500 | failed to follow newsletter: <reason> |
| 500 | failed to leave newsletter: <reason> |
| 501 | WhatsApp client does not support <method> |
Next
Create channel
Create a new channel linked to the account.
List channels
Return subscribed channels.