Skip to main content
GET
/
api
/
newsletter
/
info
/
:instance
Newsletter info
curl --request GET \
  --url https://api.example.com/api/newsletter/info/:instance \
  --header 'token: <token>'

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 • Rate-limit: Global (100/min) • Idempotent: yes

​
Description

Returns the full NewsletterChannel. Useful as a preview before following a newsletter, works even if you are not subscribed.

​
Examples

​
By JID

Looks up the newsletter metadata by its canonical JID (@newsletter). Works even when the account is not subscribed, handy as a preview before calling /join. 
curl -X GET "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name?identifier=120363422585881117@newsletter" \
  -H "token: $Token_Instance"
Looks up the newsletter by the full invite link. The server URL-decodes and resolves the code before fetching the metadata, returning the same NewsletterChannel. 
curl -G "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name" \
  --data-urlencode "identifier=https://whatsapp.com/channel/120363422585881117" \
  -H "token: $Token_Instance"

​
By code

Looks up the newsletter using only the invite code (the link suffix). Same result, more concise when you already have the code on hand. 
curl -X GET "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name?identifier=120363422585881117" \
  -H "token: $Token_Instance"

​
Success response

The response returns the full NewsletterChannel, with the canonical channel.jid, current state (active, suspended, etc.), name, description, inviteLink (when available), subscriberCount and pictureUrl. The inviteLink and pictureUrl fields are optional and can be missing when the account doesn’t have permission to view them.
200 OK
{
  "success": true,
  "message": "Newsletter info retrieved",
  "channel": {
    "jid": "120363422585881117@newsletter",
    "state": "active",
    "name": "Tech News",
    "description": "Latest tech updates",
    "inviteLink": "https://whatsapp.com/channel/120363422585881117",
    "subscriberCount": 500,
    "pictureUrl": "https://example.com/tech.jpg"
  }
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Query

​
identifier
string
required
@newsletter JID, full link (https://whatsapp.com/channel/<id>) or just the code (<id>).

​
Notes

  • This is the right way to preview before calling /join.
  • subscriberCount may be slightly stale (WhatsApp cache).
  • Codes are case-sensitive: ABC123 is not the same as abc123.
  • inviteLink only comes back if the account has permission to view it.

​
Errors

HTTPMessage
400The 'identifier' query parameter is required (JID @newsletter or invite link/code)
400Invalid newsletter identifier (use JID @newsletter or invite link/code)
400newsletter not found or no metadata returned
500failed to get newsletter info: <reason>
501WhatsApp client does not support GetNewsletterInfo
Envelope: 
{
  "success": false,
  "error": { "message": "Invalid newsletter identifier (use JID @newsletter or invite link/code)" }
}