Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
projectId
string<uuid>
required
adCopy
string
required

The ad text, markup and all, used here only as the brief a channel search is derived from. Deliberately NOT judged as publishable copy: this request carries no destinationUrl, so the rule about foreign domains cannot be evaluated, and half a verdict would teach the advertiser the wrong lesson about what is checked. Campaign create is where the text is judged.

Maximum string length: 8000
platform
enum<string>
required
Available options:
TELEGRAM
objective
enum<string> | null
Available options:
AWARENESS,
TRAFFIC,
CONVERSIONS,
APP_INSTALLS

Response

Success

matchToken
string
required
channels
object[]
required
filters
object | null

Present only for match-channels-by-prompt, which is the only search that INFERS its filters instead of being told them: it reports back what it read out of the prompt. The ad-copy and look-alike searches take no filters from the caller, so they leave this absent.