Skip to main content
Retrieve a list of all newsletters (channels) that you are subscribed to.
Newsletters are WhatsApp’s broadcast channels that allow you to receive updates from organizations and creators.

​
Request

​
X-Device-Id
string
Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default.

​
Response

​
code
string
Response code (e.g., SUCCESS)
​
message
string
Response message describing the resultExample: Success get list newsletter
​
results
object
​
data
array
Array of newsletter objects
curl -X GET \
  'https://your-api-domain.com/user/my/newsletters' \
  -H 'X-Device-Id: my-device' \
  -u 'username:password'

{
  "code": "SUCCESS",
  "message": "Success get list newsletter",
  "results": {
    "data": [
      {
        "id": "120363144038483540@newsletter",
        "state": {
          "type": "active"
        },
        "thread_metadata": {
          "creation_time": "1688746895",
          "invite": "0029Va4K0PZ5a245NkngBA2M",
          "name": {
            "text": "WhatsApp",
            "id": "1688746895480511",
            "update_time": "1688746895480511"
          },
          "description": {
            "text": "WhatsApp's official channel. Follow for our latest feature launches, updates, exclusive drops and more.",
            "id": "1689653839450668",
            "update_time": "1689653839450668"
          },
          "subscribers_count": "0",
          "verification": "verified",
          "picture": {
            "url": "",
            "id": "1707950960975554",
            "type": "IMAGE"
          }
        }
      }
    ]
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us