Campaigns

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.

POST/1/campaigns

Create Campaign

Authorization
User sessionAPI credential
Permissions
campaigns:write
OAuth
-
Request
Request bodyapplication/json
descriptionstring
enabledboolean
endsAtstring <date-time>
excludeTargetingstring[]
hrefstring
kindstringREQUIRED
buttontext
labelstring
linkHrefstring
linkLabelstring
namestringREQUIRED
placesstring[]
default []
providerIdsstring[]
startsAtstring <date-time>
targetingstring[]
default []
textstring
Responses
201Created application/json
dataCampaign
createdAtstring <date-time>REQUIRED
createdBystringREQUIRED
deletedboolean
deletedAtstring <date-time>
descriptionstring
enabledbooleanREQUIRED
endsAtstring <date-time>
excludeTargetingstring[]
hrefstring
idstringREQUIRED
kindstringREQUIRED
buttontext
labelstring
linkHrefstring
linkLabelstring
namestringREQUIRED
placesstring[]REQUIRED
providerIdstringREQUIRED
providerIdsstring[]REQUIRED
startsAtstring <date-time>
targetingstring[]REQUIRED
textstring
updatedAtstring <date-time>REQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
GET/1/campaigns/live

Live Campaigns

Authorization
User sessionAPI credential
Permissions
-
OAuth
-
Responses
200Campaigns application/json
dataCampaign[]
createdAtstring <date-time>REQUIRED
createdBystringREQUIRED
deletedboolean
deletedAtstring <date-time>
descriptionstring
enabledbooleanREQUIRED
endsAtstring <date-time>
excludeTargetingstring[]
hrefstring
idstringREQUIRED
kindstringREQUIRED
buttontext
labelstring
linkHrefstring
linkLabelstring
namestringREQUIRED
placesstring[]REQUIRED
providerIdstringREQUIRED
providerIdsstring[]REQUIRED
startsAtstring <date-time>
targetingstring[]REQUIRED
textstring
updatedAtstring <date-time>REQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
POST/1/campaigns/search

Search Campaigns

Authorization
User sessionAPI credential
Permissions
campaigns:read
OAuth
-
Request
Request bodyapplication/json
enabledboolean
limitinteger
default 50min 1
placesstring[]
querystring
skipinteger
default 0min 0
Responses
200Campaigns application/json
dataCampaign[]
createdAtstring <date-time>REQUIRED
createdBystringREQUIRED
deletedboolean
deletedAtstring <date-time>
descriptionstring
enabledbooleanREQUIRED
endsAtstring <date-time>
excludeTargetingstring[]
hrefstring
idstringREQUIRED
kindstringREQUIRED
buttontext
labelstring
linkHrefstring
linkLabelstring
namestringREQUIRED
placesstring[]REQUIRED
providerIdstringREQUIRED
providerIdsstring[]REQUIRED
startsAtstring <date-time>
targetingstring[]REQUIRED
textstring
updatedAtstring <date-time>REQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
PUT/1/campaigns/{id}

Update Campaign

Authorization
User sessionAPI credential
Permissions
campaigns:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Request bodyapplication/json
descriptionstring
enabledboolean
endsAtstring <date-time>
excludeTargetingstring[]
hrefstring
kindstring
buttontext
labelstring
linkHrefstring
linkLabelstring
namestring
placesstring[]
providerIdsstring[]
startsAtstring <date-time>
targetingstring[]
textstring
Responses
200Updated application/json
dataCampaign
createdAtstring <date-time>REQUIRED
createdBystringREQUIRED
deletedboolean
deletedAtstring <date-time>
descriptionstring
enabledbooleanREQUIRED
endsAtstring <date-time>
excludeTargetingstring[]
hrefstring
idstringREQUIRED
kindstringREQUIRED
buttontext
labelstring
linkHrefstring
linkLabelstring
namestringREQUIRED
placesstring[]REQUIRED
providerIdstringREQUIRED
providerIdsstring[]REQUIRED
startsAtstring <date-time>
targetingstring[]REQUIRED
textstring
updatedAtstring <date-time>REQUIRED
metaobject
limitnumber
skipnumber
statsobject
totalnumber
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
DELETE/1/campaigns/{id}

Delete Campaign

Authorization
User sessionAPI credential
Permissions
campaigns:write
OAuth
-
Request
Path parameters1
idstringREQUIRED
Responses
204Deleted text/plain
Returns a file (Text).
400Invalid Request application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
401Unauthorized application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
404Not Found application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED
500Internal server error application/json
errorobject
detailsobject
messagestringREQUIRED
statusnumberREQUIRED
typestringREQUIRED