Schedule Buy

Pause Plan

Pause a plan: the daily executor skips it and buys nothing more.

Every credit hold stays RESERVED - pausing does not release money, it only stops it being spent. Resume picks up exactly where it left off. Org admins and owners only; 409 if the plan is not in a pausable state.

post/mailboxes/schedule-buy/plans/{plan_id}/pause

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/mailboxes/schedule-buy/plans/{plan_id}/pause
  • 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.