API Reference

search channels

post
https://waapi.app/api/v1/instances//client/action/search-channels

Search for channels

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Instance ID

Body Params
countryCodes
array of strings

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

countryCodes
string

Optional text to search for in channel names/descriptions

string
enum
Defaults to RECOMMENDED

View type for results filtering

Allowed:
integer
≥ 1
Defaults to 50

Maximum number of results to return

boolean
Defaults to false

Whether to skip already subscribed newsletters in results

Responses

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

401

Unauthorized — invalid or missing bearer token

403

Forbidden — insufficient permissions or account blocked

404

Not found — instance does not exist or does not belong to you

409

Conflict — instance is not ready

429

Too many requests — rate limit exceeded

Updated over 1 year ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago

Did this page help you?