POST
Skip Email Batch Recipients

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

batch_id
string<uuid>
required

Body

application/json

What skip, restore and retry accept — either shape.

These keep their bulk shorthand because the rule is about irreversibility, not about bulk: skipping four thousand rows is undone by restoring them, and making curation tedious pushes an operator toward not curating.

recipient_ids
string<uuid>[] | null
selection
string | null

Every row this verb can act on: draft for skip, skipped for restore, draft_failed for retry.

Allowed value: "all_eligible"

Response

Successful Response

Skip-and-report, never a partial silent accept.

job_id is set by send alone, so a client can tie a batch of rows that are visibly stuck to the scheduled_jobs row the scheduler is complaining about.

affected
integer
required
job_id
string<uuid> | null
required
rejected
RejectedRecipient · object[]
required