v1Resources/Paid Boosts/postCancel a deferred boost
Cancel a deferred boost
Cancels a boost that is still waiting for its post to publish, so nothing has been spent. When the boost exists but nothing was waiting, it answers cancelled false with the reason; an unknown id is a 404.
post
boosts:write/api/v1/boosts/deferred/{adCampaignId}/cancelQuery parameters
adCampaignIdstringrequired
The deferred boost's ad campaign id, from the list.
Response
dataobjectoptional
cancelledbooleanoptional
True when something was cancelled.
runsCancelledintegeroptional
How many boosts were cancelled.
reasonstringoptional
Why nothing was cancelled, when it was not.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/boosts/deferred/{adCampaignId}/cancel
Your API key
adCampaignId *
{
"data": {
"cancelled": true,
"runsCancelled": 1
}
}