GET /newsletters

Get all newsletters/channels the device is subscribed to

Responses

  • 200 application/json

    Newsletters retrieved successfully

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • data array[object]
      Hide data attributes Show data attributes object
      • jid string
      • name string
      • subscriber_count integer
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
GET /newsletters
curl \
 --request GET 'http://localhost:7001/newsletters' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "code": 200,
  "data": [
    {
      "jid": "120363123456789012@newsletter",
      "name": "Tech News Channel",
      "description": "Latest technology news and updates",
      "picture_url": "https://pps.whatsapp.net/v/...",
      "subscriber_count": 15000
    },
    {
      "jid": "120363123456789013@newsletter",
      "name": "My Company Updates",
      "description": "Official company announcements",
      "picture_url": null,
      "subscriber_count": 5000
    }
  ],
  "status": true,
  "message": "Newsletters retrieved successfully"
}
Response examples (200)
{
  "status": true,
  "code": 200,
  "message": "Newsletters retrieved successfully",
  "data": [
    {
      "jid": "120363123456789012@newsletter",
      "name": "My Channel",
      "subscriber_count": 1500
    }
  ]
}
Response examples (401)
{
  "code": 401,
  "error": "Invalid or expired JWT token",
  "status": false,
  "message": "Unauthorized"
}
Response examples (401)
{
  "status": false,
  "code": 401,
  "message": "Unauthorized",
  "error": "Invalid or missing authentication"
}
Response examples (500)
{
  "code": 500,
  "error": "Failed to retrieve newsletters",
  "status": false,
  "message": "Internal server error"
}
Response examples (500)
{
  "status": false,
  "code": 400,
  "message": "Bad request",
  "error": "Bad request"
}