Skip to main content
POST
/
api
/
newsletter
/
create
/
:instance
Create channel
curl --request POST \
  --url https://api.example.com/api/newsletter/create/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "picture": "<string>"
}
'

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: no (each call creates a new channel)

​
Description

Creates a new channel. The creating account automatically becomes admin / owner. The service automatically accepts the terms of use (TOS) when WhatsApp requires them, performing a transparent retry after AcceptTOSNotice.

​
Examples

​
Minimum

Creates a channel with only the required name. The channel is born without a description or picture, but already gets a permanent jid and an inviteLink in the response. 
curl -X POST "https://ryzeapi.cloud/api/newsletter/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Important News"
  }'

​
Complete

Creates the channel with description and picture (public URL). The server downloads the image, converts it to JPEG 640x640, and sets it as the channel’s initial picture. 
curl -X POST "https://ryzeapi.cloud/api/newsletter/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Important News",
    "description": "Daily updates",
    "picture": "https://example.com/logo.png"
  }'

​
With base64 picture

Same flow, but the picture goes inline as a data: URL with base64 instead of an external URL. Useful when the image is generated locally or sits behind authentication. 
curl -X POST "https://ryzeapi.cloud/api/newsletter/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Test Channel",
    "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
  }'

​
Success response

The response includes the permanent channel.jid of the freshly created channel (use it as the identifier in subsequent calls), the inviteLink ready to share, and the current state. subscriberCount starts at 0, and pictureUrl comes as null when the picture has not yet been processed or was not provided.
200 OK
{
  "success": true,
  "message": "Newsletter created successfully",
  "channel": {
    "jid": "120363422585881117@newsletter",
    "state": "active",
    "name": "Important News",
    "description": "Daily updates",
    "inviteLink": "https://whatsapp.com/channel/120363422585881117",
    "subscriberCount": 0,
    "pictureUrl": null
  }
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.
​
Content-Type
string
required
application/json

​
Request body

​
name
string
required
Channel name. Cannot be empty.
​
description
string
Channel description / bio.
​
picture
string
URL or base64. Converted to JPEG (max 640x640). A failure only logs a warning, the channel is created without a picture.

​
Notes

  • In some countries, creating a channel requires a verified WhatsApp Business account. If the server rejects, the WhatsMeow error is propagated.
  • Save the returned channel.jid, invite links can be revoked, but the JID is permanent.
  • Creation is not idempotent: an automatic retry on a network timeout can duplicate the channel.
  • The picture is resized to 640x640 keeping aspect ratio (accepted formats: JPEG, PNG, WebP, GIF).

​
Errors

HTTPMessage
400The 'name' field is required
400Instance is not connected to WhatsApp
500failed to create newsletter: <reason>
501WhatsApp client does not support newsletter creation (CreateNewsletter not available)
501failed to create newsletter (terms may need acceptance)
Envelope: 
{
  "success": false,
  "error": { "message": "The 'name' field is required" }
}

​
Next

Channel info

Confirm data after creation.

List channels

See subscribed channels.