Saltar al contenido principal
POST
/
api
/
newsletter
/
join
/
:instance
Unirse al newsletter
curl --request POST \
  --url https://api.example.com/api/newsletter/join/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "identifier": "<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: parcial (un newsletter ya seguido suele ser un no-op silencioso)

​
Descripción

Suscribe (sigue) la cuenta a un newsletter. Después del join, el newsletter aparece en GET /list y los mensajes entrantes llegan como message.exchange con chat.type = "newsletter".

​
Ejemplos

​
Por JID

Suscribe la cuenta pasando el JID canónico del newsletter (@newsletter). Es el formato más directo, no hace falta resolver un enlace o código primero. 
curl -X POST "https://ryzeapi.cloud/api/newsletter/join/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "120363422585881117@newsletter"
  }'

​
Por enlace

Suscribe la cuenta pasando el enlace de invitación completo (https://whatsapp.com/channel/...). El servidor extrae el código del sufijo de la URL y resuelve el JID antes de seguir. 
curl -X POST "https://ryzeapi.cloud/api/newsletter/join/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "https://whatsapp.com/channel/120363422585881117"
  }'

​
Por código

Suscribe la cuenta pasando solo el código de invitación (sufijo del enlace, sin el dominio). Un atajo cuando ya tienes el código extraído. 
curl -X POST "https://ryzeapi.cloud/api/newsletter/join/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "120363422585881117"
  }'

​
Respuesta exitosa

La respuesta siempre devuelve el JID canónico del newsletter en channelJid, incluso cuando el input fue un enlace o código de invitación. Usa ese valor como identifier en llamadas posteriores (/info, /leave).
200 OK
{
  "success": true,
  "message": "Successfully joined newsletter",
  "channelJid": "120363422585881117@newsletter"
}

​
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

​
identifier
string
requerido
JID @newsletter, enlace completo o código de invitación.

​
Notas

  • La respuesta siempre devuelve el JID canónico en channelJid, útil cuando el input fue un enlace / código.
  • Después del join, la propagación a GET /list puede demorar unos segundos.
  • En casos raros, los newsletters privados requieren aprobación del propietario, join devuelve éxito pero el newsletter solo aparece en list después de la aprobación.
  • Los enlaces de invitación pueden ser revocados por el propietario, los códigos antiguos comienzan a fallar con newsletter not found.

​
Errores

HTTPMensaje
400The 'identifier' field is required (JID @newsletter or invite link/code)
400Invalid newsletter identifier (use JID @newsletter or invite link/code)
400newsletter not found
500failed to follow newsletter: <reason>
501WhatsApp client does not support FollowNewsletter
Envoltorio: 
{
  "success": false,
  "error": { "message": "newsletter not found" }
}