Schedule Buy

Cancel Plan

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.

delete/mailboxes/schedule-buy/plans/{plan_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/mailboxes/schedule-buy/plans/{plan_id}
  • Auth: HTTP bearer

Path parameters

plan_idinteger required

Schedule Buy plan id - from GET /mailboxes/schedule-buy/plans

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataMailboxDomainPayload required

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.

Changes

No recorded changes to this operation across all 2 revisions of this API.