v1Resources/Paid Boosts/postStop a live boost
Stop a live boost
Stops a boost that is already spending, which halts the ad on the network. This cannot be resumed; create a new boost instead. To call off one that has not gone live, cancel it.
post
boosts:write/api/v1/boosts/{adRunId}/stopQuery parameters
adRunIdstringrequired
The boost's id.
Response
dataobjectoptional
stoppedbooleanoptional
True when the boost was stopped.
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/{adRunId}/stop
Your API key
adRunId *
{
"data": {
"stopped": true
}
}