v1Ressources/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}/cancelParamètres de requête
adCampaignIdstringobligatoire
The deferred boost's ad campaign id, from the list.
Réponse
dataobjectfacultatif
cancelledbooleanfacultatif
True when something was cancelled.
runsCancelledintegerfacultatif
How many boosts were cancelled.
reasonstringfacultatif
Why nothing was cancelled, when it was not.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/boosts/deferred/{adCampaignId}/cancel
Votre clé API
adCampaignId *
{
"data": {
"cancelled": true,
"runsCancelled": 1
}
}