Park Ads for Customer
This endpoint parks an ad or ads for a customer. Useful when a customer wished to hide a specific ad.
| PUT /customers/<token>/ads/parked
|
In addition to the query parameter, this endpoint requires a JSON body be posted.
| Path Param |
Type |
Required |
Description |
| token |
string |
Required |
The security token for the customer |
| JSON Prop |
Type |
Required |
Description |
| ads |
DisplayServingAd[] |
Required |
An array of the impression tokens and additional metadata of the ads being parked. |
Output
This endpoint returns an HTTP response indicating success (200) or failure (500).
Example
Request
| PUT /api/v1/customers/C1FA3C38-1B28-4B54-A2F8-E577FFEEF9F5/ads/parked
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29 | {
"ads":[
{
"impressionToken" : "91e471aed3c04b81bee792f23ad4859d",
"channelId" : 1,
"locationId" : 32,
"displayTypeId" : 6,
"tags": [],
"imageSlots": [
"logo"
],
"displayPosition": 4
},
{
"impressionToken" : "eb2176a194ca4d56aae5b88509f5f70e",
"channelId": 1,
"locationId": 32,
"displayTypeId": 6,
"tags": [
"purchase-channel"
],
"imageSlots": [
"logo",
"heroImage"
],
"displayPosition": 12
}
]
}
|
Response