Join newsletter

POST

api

newsletter

join

:instance

Join newsletter

curl --request POST \
  --url https://api.example.com/api/newsletter/join/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "identifier": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({identifier: '<string>'})
};

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

import requests

url = "https://api.example.com/api/newsletter/join/:instance"

payload = { "identifier": "<string>" }
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: partial (an already-followed newsletter is usually a silent no-op)

Description

Subscribes (follows) the account to a newsletter. After join, the newsletter shows up on GET /list and incoming messages arrive as message.exchange with chat.type = "newsletter".

Examples

By JID

Subscribes the account by passing the canonical newsletter JID (@newsletter). It’s the most direct format, no need to resolve a link or code first.

curl -X POST "https://ryzeapi.cloud/api/newsletter/join/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "120363422585881117@newsletter"
  }'

await fetch(`https://ryzeapi.cloud/api/newsletter/join/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    identifier: "120363422585881117@newsletter"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/newsletter/join/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "identifier": "120363422585881117@newsletter"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "identifier": "120363422585881117@newsletter"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/newsletter/join/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

By link

Subscribes the account by passing the full invite link (https://whatsapp.com/channel/...). The server extracts the code from the URL suffix and resolves the JID before following.

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

await fetch(`https://ryzeapi.cloud/api/newsletter/join/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    identifier: "https://whatsapp.com/channel/120363422585881117"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/newsletter/join/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "identifier": "https://whatsapp.com/channel/120363422585881117"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "identifier": "https://whatsapp.com/channel/120363422585881117"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/newsletter/join/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

By code

Subscribes the account by passing only the invite code (link suffix, without the domain). A shortcut for when you’ve already extracted the code.

curl -X POST "https://ryzeapi.cloud/api/newsletter/join/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "identifier": "120363422585881117"
  }'

await fetch(`https://ryzeapi.cloud/api/newsletter/join/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    identifier: "120363422585881117"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/newsletter/join/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "identifier": "120363422585881117"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "identifier": "120363422585881117"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/newsletter/join/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Success response

The response always returns the canonical newsletter JID in channelJid, even when the input was a link or invite code. Use that value as the identifier in subsequent calls (/info, /leave).

200 OK

{
  "success": true,
  "message": "Successfully joined newsletter",
  "channelJid": "120363422585881117@newsletter"
}

Path parameters

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json

Request body

string

required

@newsletter JID, full link or invite code.

Notes

The response always returns the canonical JID in channelJid, useful when the input was a link / code.
After join, the propagation to GET /list can take a few seconds.
In rare cases, private newsletters require approval from the owner, join returns success but the newsletter only shows up in list after the approval.
Invite links can be revoked by the owner, old codes start failing with newsletter not found.

Errors

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

Envelope:

{
  "success": false,
  "error": { "message": "newsletter not found" }
}

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Join newsletter

Description

Examples

By JID

By link

By code

Success response

Path parameters

Headers

Request body

Notes

Errors

​Description

​Examples

​By JID

​By link

​By code

​Success response

​Path parameters

​Headers

​Request body

​Notes

​Errors

Description

Examples

By JID

By link

By code

Success response

Path parameters

Headers

Request body

Notes

Errors