Pular para o conteúdo principal
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>"
}
'

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

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

​
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

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.
​
Content-Type
string
obrigatório
application/json

​
Request body

​
identifier
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

HTTPMensagem
400The 'identifier' field is required (JID @newsletter or invite link/code)
400Invalid newsletter identifier (use JID @newsletter or invite link/code)
400newsletter not found
500failed to follow newsletter: <reason>
501WhatsApp client does not support FollowNewsletter
Envelope: 
{
  "success": false,
  "error": { "message": "newsletter not found" }
}