channel

search channels

Search for channels

post/instances/{id}/client/action/search-channels

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/search-channels
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

countryCodesstring[]

Optional array of ISO 3166-1 alpha-2 country codes to filter channels

searchTextstring

Optional text to search for in channel names/descriptions

view'RECOMMENDED' | 'TRENDING' | 'POPULAR' | 'NEW'

View type for results filtering

limitinteger

Maximum number of results to return

skipSubscribedNewslettersboolean

Whether to skip already subscribed newsletters in results

Example request

{
  "countryCodes": [
    "US",
    "GB"
  ],
  "searchText": "news",
  "view": "RECOMMENDED",
  "limit": 50
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Returns matching channels.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success",
    "data": [
      {
        "id": {
          "server": "newsletter",
          "user": "120363184333444555",
          "_serialized": "120363184333444555@newsletter"
        },
        "t": 1701959820,
        "name": "Example Channel",
        "channelMetadata": {
          "id": {
            "server": "newsletter",
            "user": "120363184333444555",
            "_serialized": "120363184333444555@newsletter"
          },
          "creationTime": 1701959820,
          "name": "Example Channel",
          "description": "Example channel description",
          "size": 16979,
          "verified": true
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.