Create channel

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>"
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({name: '<string>', description: '<string>', picture: '<string>'})
};

fetch('https://api.example.com/api/newsletter/create/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/newsletter/create/:instance"

payload = {
    "name": "<string>",
    "description": "<string>",
    "picture": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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"
  }'

await fetch(`https://ryzeapi.cloud/api/newsletter/create/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Important News"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/newsletter/create/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "name": "Important News"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "name": "Important News"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/newsletter/create/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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"
  }'

await fetch(`https://ryzeapi.cloud/api/newsletter/create/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name:        "Important News",
    description: "Daily updates",
    picture:     "https://example.com/logo.png"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/newsletter/create/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "name":        "Important News",
        "description": "Daily updates",
        "picture":     "https://example.com/logo.png"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "name":        "Important News",
        "description": "Daily updates",
        "picture":     "https://example.com/logo.png"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/newsletter/create/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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=="
  }'

await fetch(`https://ryzeapi.cloud/api/newsletter/create/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name:    "Test Channel",
    picture: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/newsletter/create/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "name":    "Test Channel",
        "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "name":    "Test Channel",
        "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/newsletter/create/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json

Request body

string

required

Channel name. Cannot be empty.

string

Channel description / bio.

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

HTTP	Message
400	`The 'name' field is required`
400	`Instance is not connected to WhatsApp`
500	`failed to create newsletter: <reason>`
501	`WhatsApp client does not support newsletter creation (CreateNewsletter not available)`
501	`failed to create newsletter (terms may need acceptance)`

Envelope:

{
  "success": false,
  "error": { "message": "The 'name' field is required" }
}

Channel info

Confirm data after creation.

List channels

See subscribed channels.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

Minimum

Complete

With base64 picture

Success response

Path parameters

Headers

Request body

Notes

Errors

Next

Channel info

List channels

​Description

​Examples

​Minimum

​Complete

​With base64 picture

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Errors

​Next

Channel info

List channels

Description

Examples

Minimum

Complete

With base64 picture

Success response

Path parameters

Headers

Request body

Notes

Errors

Next