Skip to main content
GET
Error

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
campaignId
string<uuid>
required

Response

Success

​
id
string<uuid>
required
​
projectId
string<uuid>
required
​
name
string
required
​
destinationUrl
string
required

As stored, which is as it was sent except that the names of any known placeholders (see CreateCampaignRequest.destinationUrl) have been lowercased. Placeholders are never substituted here: what each one becomes depends on the placement, and this is the campaign.

​
adCopy
string
required
​
platform
enum<string>
required
Available options:
TELEGRAM
​
distributionType
enum<string>
required
Available options:
RECOMMENDED,
MANUAL
​
mediaAssets
object[]
required
​
budget
string
required
Pattern: ^-?\d+(\.\d{1,6})?$
Example:

"125.500000"

​
startsAt
string<date>
required
​
endsAt
string<date>
required
​
dailyDistribution
object[]
required
​
approvalMode
enum<string>
required
Available options:
OPERATOR,
USER
​
creativeChangesAllowed
boolean
required
​
status
enum<string>
required
Available options:
ACTIVE,
COMPLETED,
ARCHIVED
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
objective
enum<string> | null
Available options:
AWARENESS,
TRAFFIC,
CONVERSIONS,
APP_INSTALLS