v1Recursos/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
Parámetros de consulta
adCampaignIdstringobligatorio
The deferred boost's ad campaign id, from the list.
Respuesta
dataobjectopcional
cancelledbooleanopcional
True when something was cancelled.
runsCancelledintegeropcional
How many boosts were cancelled.
reasonstringopcional
Why nothing was cancelled, when it was not.
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/boosts/deferred/{adCampaignId}/cancel
Su clave de API
adCampaignId *
{
  "data": {
    "cancelled": true,
    "runsCancelled": 1
  }
}

¿Nuevo en la API de Synup?