Schedule Buy

List Plan Batches

One page of a plan's batch history, oldest batch first. SPENDS NOTHING. 404 for a plan that is not the organisation's.

get/mailboxes/schedule-buy/plans/{plan_id}/batches

Request

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

Path parameters

plan_idinteger required

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

Query parameters

pageinteger

1-based page index.

limitinteger

Rows per page.

return_totalboolean

Include a real COUNT over the matching set.

agFilterModelstring nullable

AG Grid filterModel JSON.

agSortModelstring nullable

AG Grid sortModel JSON.

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.