> ## 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.

# Newsletter info

> Fetches the details of a newsletter by JID, link or invite code

**Auth:** `TokenAccount` or `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotent:** yes

## Description

Returns the full `NewsletterChannel`. Useful as a preview before following a newsletter, works even if you are **not subscribed**.

## Examples

### By JID

Looks up the newsletter metadata by its canonical JID (`@newsletter`). Works even when the account is not subscribed, handy as a preview before calling `/join`.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name?identifier=120363422585881117@newsletter" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/newsletter/info/${process.env.Instance_Name}?identifier=120363422585881117@newsletter`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

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

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

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

### By link

Looks up the newsletter by the full invite link. The server URL-decodes and resolves the code before fetching the metadata, returning the same `NewsletterChannel`.

<CodeGroup>
  ```bash cURL theme={null}
  curl -G "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name" \
    --data-urlencode "identifier=https://whatsapp.com/channel/120363422585881117" \
    -H "token: $Token_Instance"
  ```

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

  ```python Python theme={null}
  import os, requests

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

  ```go Go theme={null}
  package main

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

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

### By code

Looks up the newsletter using only the invite code (the link suffix). Same result, more concise when you already have the code on hand.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name?identifier=120363422585881117" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/newsletter/info/${process.env.Instance_Name}?identifier=120363422585881117`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

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

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

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

## Success response

The response returns the full `NewsletterChannel`, with the canonical `channel.jid`, current `state` (`active`, `suspended`, etc.), name, description, `inviteLink` (when available), `subscriberCount` and `pictureUrl`. The `inviteLink` and `pictureUrl` fields are optional and can be missing when the account doesn't have permission to view them.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Newsletter info retrieved",
  "channel": {
    "jid": "120363422585881117@newsletter",
    "state": "active",
    "name": "Tech News",
    "description": "Latest tech updates",
    "inviteLink": "https://whatsapp.com/channel/120363422585881117",
    "subscriberCount": 500,
    "pictureUrl": "https://example.com/tech.jpg"
  }
}
```

## Path parameters

<ParamField path="instance" type="string" required>
  Instance name.
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` or `TokenInstance`.
</ParamField>

## Query

<ParamField query="identifier" type="string" required>
  `@newsletter` JID, full link (`https://whatsapp.com/channel/<id>`) or just the code (`<id>`).
</ParamField>

## Notes

<Note>
  * This is the right way to **preview** before calling [`/join`](/en/api/newsletter/join).
  * `subscriberCount` may be slightly stale (WhatsApp cache).
  * Codes are **case-sensitive**: `ABC123` is not the same as `abc123`.
  * `inviteLink` only comes back if the account has permission to view it.
</Note>

## 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)`            |
| 400  | `newsletter not found or no metadata returned`                                       |
| 500  | `failed to get newsletter info: <reason>`                                            |
| 501  | `WhatsApp client does not support GetNewsletterInfo`                                 |

Envelope:

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