Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: 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

MethodPathFunction
POST/api/newsletter/create/:instanceCreate channel
GET/api/newsletter/list/:instanceList subscribed channels
GET/api/newsletter/info/:instanceChannel info
POST/api/newsletter/join/:instanceSubscribe
DELETE/api/newsletter/leave/:instanceUnsubscribe

​
Accepted identifiers

The info, join, and leave endpoints accept:
FormExample
JID120363422585881117@newsletter
Full linkhttps://whatsapp.com/channel/120363422585881117
Code only120363422585881117

​
NewsletterChannel model

FieldTypeDescription
jidstring<id>@newsletter
statestringactive, suspended, geosuspended
namestringChannel name
descriptionstringMay be empty
inviteLinkstring?https://whatsapp.com/channel/<id> (admins / creator only)
subscriberCountintMay be 0 if unknown
pictureUrlstring?Temporary URL from WhatsApp’s CDN

​
Channel states

StateMeaning
activeOperational channel, accepting posts and new followers
suspendedChannel suspended (policy violation), visible but no interaction
geosuspendedChannel unavailable in your region

​
Error envelope

{
  "success": false,
  "error": { "message": "newsletter not found" }
}

​
WhatsMeow client support

Some routes depend on WhatsMeow client functions that may not be available in certain builds. When that happens, the server returns HTTP 501 with specific messages:
  • WhatsApp client does not support newsletter creation
  • WhatsApp client does not support listing newsletters
  • WhatsApp client does not support FollowNewsletter
  • WhatsApp client does not support UnfollowNewsletter

​
Error reference (summary)

HTTPMessage
400The 'name' field is required
400The 'identifier' query parameter is required (JID @newsletter or invite link/code)
400Invalid newsletter identifier (use JID @newsletter or invite link/code)
400Instance is not connected to WhatsApp
404newsletter not found
500failed to create newsletter: <reason>
500failed to follow newsletter: <reason>
500failed to leave newsletter: <reason>
501WhatsApp client does not support <method>

​
Next

Create channel

Create a new channel linked to the account.

List channels

Return subscribed channels.