Pause Scheduled Placement Test
POST /placement/scheduled/{schedule_id}/pause
Stop a recurring test charging. Reversible with /resume.
Pausing does not refund a run already charged; it stops the next one.
Authorizations
Parameters
Path Parameters
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.
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.
Header Parameters
Responses
200
Successful Response
object
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”.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error