Schedule Buy

Get Plan

One plan and every batch it has run, in order.

A batch carries what it bought and what it was charged. The internal credit-ledger transaction ids are deliberately not published - use GET /usage for the ledger.

get/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.