Cancel Plan
DELETE /mailboxes/schedule-buy/plans/{plan_id}
Cancel a plan and release every hold it has not yet spent. NOT REVERSIBLE.
Batches already bought stay bought - this stops the plan buying MORE. The released credits return to the org’s balance; there is no un-cancel, so a plan you want to stop temporarily is a different operation.
Org admins and owners only. 409 if the plan is executing a batch right now (retry in a few minutes - cancelling mid-batch could release a hold the executor is about to charge) or if the plan is in a state that cannot be cancelled at all.
Authorizations
Parameters
Path Parameters
Schedule Buy plan id - from GET /mailboxes/schedule-buy/plans
Schedule Buy plan id - from GET /mailboxes/schedule-buy/plans
Header Parameters
Responses
200
Successful Response
object
An open envelope for one provider/deliverability result.
Open on purpose. These payloads are provider state and advisory reads whose
contents grow with the product, and a dropped field reads as “nothing to
report” rather than “we did not tell you”. Every value passes through
scrub_vendor_names on the way in.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error