Skip to content

Pause Plan

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

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.

Authorizations

Parameters

Path Parameters

plan_id
required

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

integer
>= 1

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

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string