Skip to main content
DELETE
/
api
/
newsletter
/
leave
/
:instance
Leave 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 or TokenInstance • Rate-limit: Global (100/min) • Idempotent: partial (leaving a newsletter you don’t follow may return not found)

​
Description

Cancels the subscription (unfollow). Future messages stop arriving and the newsletter disappears from GET /list. The identifier is passed as a query string (not in the body), since this is a DELETE.

​
Examples

​
By JID

Cancels the subscription by passing the canonical newsletter JID through the query string. Future messages stop arriving and the newsletter disappears from GET /list. 
curl -X DELETE "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name?identifier=120363422585881117@newsletter" \
  -H "token: $Token_Instance"
Cancels the subscription by passing the full invite link. The server extracts the code, resolves the JID and runs the 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"

​
By code

Cancels the subscription by passing only the invite code. Same as the link, without the domain prefix. 
curl -X DELETE "https://ryzeapi.cloud/api/newsletter/leave/$Instance_Name?identifier=120363422585881117" \
  -H "token: $Token_Instance"

​
Success response

The response returns the canonical newsletter JID in channelJid (resolved from the identifier passed in the query, even if it was a link or code). After this return, the newsletter is removed from /list and future messages stop arriving.
200 OK
{
  "success": true,
  "message": "Successfully left newsletter",
  "channelJid": "120363422585881117@newsletter"
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Query

​
identifier
string
required
@newsletter JID, full link or invite code.

​
Notes

  • If you are the owner / admin of the newsletter, leave only unsubscribes you, the newsletter keeps existing. To delete the newsletter, use the official WhatsApp interface.
  • DELETE without a body is the convention; a JSON body is ignored.
  • There is no dedicated “unfollowed” event on the webhook; newsletter messages simply stop arriving.

​
Errors

HTTPMessage
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
Envelope: 
{
  "success": false,
  "error": { "message": "Invalid newsletter identifier (use JID @newsletter or invite link/code)" }
}

​
Next

List newsletters

Confirm that the newsletter was removed.

Join again

Subscribe to another newsletter.