Saltar al contenido principal
POST
/
api
/
newsletter
/
create
/
:instance
Crear canal
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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: no (cada llamada crea un nuevo canal)

​
Descripción

Crea un nuevo canal. La cuenta creadora se convierte automáticamente en administrador / propietario. El servicio acepta automáticamente los términos de uso (TOS) cuando WhatsApp los requiere, realizando un retry transparente luego de AcceptTOSNotice.

​
Ejemplos

​
Mínimo

Crea un canal solo con el name requerido. El canal nace sin descripción ni imagen, pero ya obtiene un jid permanente y un inviteLink en la respuesta. 
curl -X POST "https://ryzeapi.cloud/api/newsletter/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Important News"
  }'

​
Completo

Crea el canal con description y picture (URL pública). El servidor descarga la imagen, la convierte a JPEG 640x640 y la fija como imagen inicial del canal. 
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"
  }'

​
Con imagen base64

Mismo flujo, pero la imagen va inline como una URL data: con base64 en lugar de una URL externa. Útil cuando la imagen se genera localmente o está detrás de autenticación. 
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=="
  }'

​
Respuesta exitosa

La respuesta incluye el channel.jid permanente del canal recién creado (úsalo como identifier en llamadas posteriores), el inviteLink listo para compartir y el state actual. subscriberCount comienza en 0, y pictureUrl viene como null cuando la imagen aún no fue procesada o no fue proporcionada.
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
  }
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.
​
Content-Type
string
requerido
application/json

​
Cuerpo de la solicitud

​
name
string
requerido
Nombre del canal. No puede estar vacío.
​
description
string
Descripción / bio del canal.
​
picture
string
URL o base64. Convertida a JPEG (máx. 640x640). Un fallo solo registra una advertencia, el canal se crea sin imagen.

​
Notas

  • En algunos países, crear un canal requiere una cuenta WhatsApp Business verificada. Si el servidor rechaza, el error de WhatsMeow se propaga.
  • Guarda el channel.jid devuelto, los enlaces de invitación pueden revocarse, pero el JID es permanente.
  • La creación no es idempotente: un retry automático ante un timeout de red puede duplicar el canal.
  • La imagen se redimensiona a 640x640 manteniendo proporción (formatos aceptados: JPEG, PNG, WebP, GIF).

​
Errores

HTTPMensaje
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)
Envoltorio: 
{
  "success": false,
  "error": { "message": "The 'name' field is required" }
}

​
Siguiente

Información del canal

Confirma los datos después de la creación.

Listar canales

Mira los canales suscritos.