Skip to main content
GET
/
newsletters
List subscribed newsletters
curl --request GET \
  --url https://api.wsapi.chat/newsletters \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "subscriberCount": 123,
    "verificationState": "<string>",
    "pictureUrl": "<string>",
    "inviteCode": "<string>",
    "role": "<string>",
    "mute": "<string>",
    "state": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Response

List of newsletters

​
id
string

Newsletter JID

​
name
string

Newsletter name

​
description
string

Newsletter description

​
subscriberCount
integer

Number of subscribers

​
verificationState
string

Verification state of the newsletter

​
pictureUrl
string

Profile picture URL

​
inviteCode
string

Invite code for the newsletter

​
role
string

Current user's role in the newsletter

​
mute
string

Mute state for the current user

​
state
string

Newsletter state

​
createdAt
string<date-time>

Creation timestamp