Saltar al contenido principal
DELETE
/
api
/
newsletter
/
leave
/
:instance
Salir del newsletter
curl --request DELETE \
  --url https://api.example.com/api/newsletter/leave/:instance \
  --header 'token: <token>'

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 (salir de un newsletter que no sigues puede devolver not found)

​
Descripción

Cancela la suscripción (unfollow). Los mensajes futuros dejan de llegar y el newsletter desaparece de GET /list. El identifier se pasa como query string (no en el body), ya que se trata de un DELETE.

​
Ejemplos

​
Por JID

Cancela la suscripción pasando el JID canónico del newsletter a través del query string. Los mensajes futuros dejan de llegar y el newsletter desaparece de GET /list. 
curl -X DELETE "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name?identifier=120363422585881117@newsletter" \
  -H "token: $Token_Instance"

​
Por enlace

Cancela la suscripción pasando el enlace de invitación completo. El servidor extrae el código, resuelve el JID y ejecuta el unfollow. 
curl -X DELETE -G "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name" \
  --data-urlencode "identifier=https://whatsapp.com/channel/120363422585881117" \
  -H "token: $Token_Instance"

​
Por código

Cancela la suscripción pasando solo el código de invitación. Igual que con el enlace, sin el prefijo del dominio. 
curl -X DELETE "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name?identifier=120363422585881117" \
  -H "token: $Token_Instance"

​
Respuesta exitosa

La respuesta devuelve el JID canónico del newsletter en channelJid (resuelto desde el identifier pasado en la query, incluso si fue un enlace o código). Después de este retorno, el newsletter se elimina de /list y los mensajes futuros dejan de llegar.
200 OK
{
  "success": true,
  "message": "Successfully left newsletter",
  "channelJid": "120363422585881117@newsletter"
}

​
Parámetros de ruta

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Query

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

​
Notas

  • Si eres el propietario / administrador del newsletter, leave solo cancela tu suscripción, el newsletter sigue existiendo. Para eliminar el newsletter, usa la interfaz oficial de WhatsApp.
  • DELETE sin body es la convención; un body JSON se ignora.
  • No hay un evento dedicado de “unfollowed” en el webhook; los mensajes del newsletter simplemente dejan de llegar.

​
Errores

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

​
Siguiente

Listar newsletters

Confirma que el newsletter fue eliminado.

Unirse de nuevo

Suscríbete a otro newsletter.