Pular para o conteúdo principal
POST
/
api
/
newsletter
/
create
/
:instance
Criar 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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: não (cada chamada cria um canal novo)

​
Descrição

Cria um novo canal. A conta criadora torna-se automaticamente admin / dono. O serviço aceita os termos de uso (TOS) automaticamente quando o WhatsApp os exigir, fazendo um retry transparente após AcceptTOSNotice.

​
Exemplos

​
Mínimo

Cria um canal apenas com o name obrigatório. O canal nasce sem descrição nem foto, mas já recebe um jid permanente e um inviteLink no response. 
curl -X POST "https://ryzeapi.cloud/api/newsletter/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Notícias Importantes"
  }'

​
Completo

Cria o canal já com description e picture (URL pública). O servidor baixa a imagem, converte para JPEG 640x640 e define como foto inicial do canal. 
curl -X POST "https://ryzeapi.cloud/api/newsletter/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Notícias Importantes",
    "description": "Atualizações diárias",
    "picture": "https://exemplo.com/logo.png"
  }'

​
Com foto base64

Mesmo fluxo, mas a foto vai inline como data: URL com base64 em vez de URL externa. Útil quando a imagem é gerada localmente ou está atrás de autenticação. 
curl -X POST "https://ryzeapi.cloud/api/newsletter/create/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Canal de Testes",
    "picture": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
  }'

​
Resposta de sucesso

A resposta inclui o channel.jid permanente do canal recém-criado (use-o como identifier nas chamadas subsequentes), o inviteLink pronto para compartilhar e o state atual. subscriberCount começa em 0 e pictureUrl vem null quando a foto ainda não foi processada ou não foi enviada.
200 OK
{
  "success": true,
  "message": "Newsletter created successfully",
  "channel": {
    "jid": "120363422585881117@newsletter",
    "state": "active",
    "name": "Notícias Importantes",
    "description": "Atualizações diárias",
    "inviteLink": "https://whatsapp.com/channel/120363422585881117",
    "subscriberCount": 0,
    "pictureUrl": null
  }
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json

​
Request body

​
name
string
obrigatório
Nome do canal. Não pode ser vazio.
​
description
string
Descrição / bio do canal.
​
picture
string
URL ou base64. Convertida para JPEG (máx 640×640). Falha apenas loga warning, o canal é criado sem foto.

​
Notas

  • Em alguns países, criar canal exige conta WhatsApp Business verificada. Se o servidor rejeitar, o erro do WhatsMeow é propagado.
  • Guarde o channel.jid retornado, links de convite podem ser revogados, mas o JID é permanente.
  • A criação não é idempotente: retry automático em timeout de rede pode duplicar o canal.
  • A foto é redimensionada para 640x640 mantendo aspect ratio (formatos aceitos: JPEG, PNG, WebP, GIF).

​
Erros

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

​
Próximo

Info do canal

Confirmar dados após a criação.

Listar canais

Ver os canais inscritos.