v1Ressourcen/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/api/v1/boosts/deferred/{adCampaignId}/cancel
boosts:write
Query-Parameter
adCampaignIdstringerforderlich
The deferred boost's ad campaign id, from the list.
Antwort
dataobjectoptional
cancelledbooleanoptional
True when something was cancelled.
runsCancelledintegeroptional
How many boosts were cancelled.
reasonstringoptional
Why nothing was cancelled, when it was not.
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/boosts/deferred/{adCampaignId}/cancel
Ihr API-Schlüssel
adCampaignId *
{
  "data": {
    "cancelled": true,
    "runsCancelled": 1
  }
}

Neu bei der Synup-API?