POST
Send 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

The ONLY shape send accepts. 1..50 ids, named.

There is deliberately no selection shorthand here — see MAX_SEND_PER_PRESS. The three sender fields apply to THIS press alone; each omitted one falls back to the batch's, and none of them writes back.

recipient_ids
string<uuid>[]
required
Required array length: 1 - 50 elements
from_email
string | null
from_name
string | null
Maximum string length: 200
reply_to
string | null

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