Leave newsletter

DELETE

api

newsletter

leave

:instance

Leave newsletter

curl --request DELETE \
  --url https://api.example.com/api/newsletter/leave/:instance \
  --header 'token: <token>'

const options = {method: 'DELETE', headers: {token: '<token>'}};

fetch('https://api.example.com/api/newsletter/leave/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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"

await fetch(`https://ryzeapi.cloud/api/newsletter/leave/${process.env.Instance_Name}?identifier=120363422585881117@newsletter`, {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.delete(
    f"https://ryzeapi.cloud/api/newsletter/leave/{os.environ['Instance_Name']}",
    params={"identifier": "120363422585881117@newsletter"},
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/newsletter/leave/"+os.Getenv("Instance_Name")+"?identifier=120363422585881117@newsletter", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

By link

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"

const params = new URLSearchParams({ identifier: "https://whatsapp.com/channel/120363422585881117" });
await fetch(`https://ryzeapi.cloud/api/newsletter/leave/${process.env.Instance_Name}?${params}`, {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.delete(
    f"https://ryzeapi.cloud/api/newsletter/leave/{os.environ['Instance_Name']}",
    params={"identifier": "https://whatsapp.com/channel/120363422585881117"},
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "net/url"
    "os"
)

func main() {
    q := url.Values{}
    q.Set("identifier", "https://whatsapp.com/channel/120363422585881117")
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/newsletter/leave/"+os.Getenv("Instance_Name")+"?"+q.Encode(), nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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"

await fetch(`https://ryzeapi.cloud/api/newsletter/leave/${process.env.Instance_Name}?identifier=120363422585881117`, {
  method: "DELETE",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.delete(
    f"https://ryzeapi.cloud/api/newsletter/leave/{os.environ['Instance_Name']}",
    params={"identifier": "120363422585881117"},
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("DELETE", "https://ryzeapi.cloud/api/newsletter/leave/"+os.Getenv("Instance_Name")+"?identifier=120363422585881117", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

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

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

Query

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

HTTP	Message
400	`The 'identifier' query parameter is required (JID @newsletter or invite link/code)`
400	`Invalid newsletter identifier (use JID @newsletter or invite link/code)`
500	`failed to leave newsletter: <reason>`
501	`WhatsApp client does not support UnfollowNewsletter`

Envelope:

{
  "success": false,
  "error": { "message": "Invalid newsletter identifier (use JID @newsletter or invite link/code)" }
}

List newsletters

Confirm that the newsletter was removed.

Join again

Subscribe to another newsletter.

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Leave newsletter

Description

Examples

By JID

By link

By code

Success response

Path parameters

Headers

Query

Notes

Errors

Next

List newsletters

Join again

​Description

​Examples

​By JID

​By link

​By code

​Success response

​Path parameters

​Headers

​Query

​Notes

​Errors

​Next

List newsletters

Join again

Description

Examples

By JID

By link

By code

Success response

Path parameters

Headers

Query

Notes

Errors

Next