Entrar no canal

POST

api

newsletter

join

:instance

Entrar no canal

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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: parcial (canal já seguido normalmente é no-op silencioso)

Descrição

Inscreve a conta (follow) em um canal. Após o join, o canal aparece em GET /list e mensagens futuras chegam como message.exchange com chat.type = "newsletter".

Exemplos

Por JID

Inscreve a conta passando o JID canônico do canal (@newsletter). É o formato mais direto, sem precisar resolver link ou código antes.

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)
}

Por link

Inscreve a conta passando o link de convite completo (https://whatsapp.com/channel/...). O servidor extrai o código do final da URL e resolve o JID antes do follow.

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)
}

Por código

Inscreve a conta passando apenas o código de convite (sufixo do link, sem o domínio). Atalho para quem já extraiu o código previamente.

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)
}

Resposta de sucesso

A resposta sempre traz o JID canônico do canal em channelJid, mesmo quando a entrada foi feita por link ou código de convite. Use esse valor como identifier em chamadas subsequentes (/info, /leave).

200 OK

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

Parâmetros de rota

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json

Request body

string

obrigatório

JID @newsletter, link completo ou código de convite.

Notas

O response sempre traz o JID canônico em channelJid, útil quando o input foi link / código.
Após join, a propagação para GET /list pode levar alguns segundos.
Em raros casos, canais privados exigem aprovação do dono, o join retorna sucesso mas o canal só aparece em list após a aprovação.
Links de convite podem ser revogados pelo dono, códigos antigos passam a falhar com newsletter not found.

Erros

HTTP	Mensagem
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" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Entrar no canal

Descrição

Exemplos

Por JID

Por link

Por código

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros

​Descrição

​Exemplos

​Por JID

​Por link

​Por código

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Notas

​Erros

Descrição

Exemplos

Por JID

Por link

Por código

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros