Mailboxes

Pause Scheduled Placement Test

Stop a recurring test charging. Reversible with /resume.

Pausing does not refund a run already charged; it stops the next one.

post/placement/scheduled/{schedule_id}/pause

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/placement/scheduled/{schedule_id}/pause
  • Auth: HTTP bearer

Path parameters

schedule_idstring required

Schedule id. A STRING, not a number: it is an opaque InboxKit identifier persisted as inboxkit_schedule_id VARCHAR(100) and interpolated straight into an InboxKit URL. test_id, domain_id and mailbox_id on this surface really are integers - the app draws the same distinction, and flattening it would 422 every id GET /placement/scheduled hands back.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataDeliverabilityPayload required

An open envelope for a test, a schedule or a warmup report.

Open because placement results carry one panel per seed provider and the provider set changes; a closed model would drop a panel, and a missing panel on a deliverability report reads as "we did not test there" when the truth may be "you did not land there".

Changes

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