PATCH
Patch Email Batch Recipient

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
recipient_id
string<uuid>
required

Body

application/json

One human edit, merged over what the CSV and the model produced.

Keys are column names in the merged space; an empty string clears an override and falls back to whatever was underneath it. Stored apart from output so "what the model wrote" and "what we actually sent" are both answerable afterwards.

overrides
Overrides · object
required

Response

Successful Response

One row of the review spreadsheet.

columns is the merged space — input, then output, then overrides — which is what the three mapped fields resolve against and what the table renders. The three halves are returned beside it so an edited cell can be marked and "what the model wrote" stays readable under the edit.

attempts
integer
required
columns
Columns · object
required
id
string<uuid>
required
input
Input · object
required
last_error
string | null
required
not_ready_reason
string | null
required
output
Output · object | null
required
overrides
Overrides · object
required
row_number
integer
required
send_attempts
integer
required
send_job_id
string<uuid> | null
required
sent_at
string<date-time> | null
required
sent_from
string | null
required
skip_reason
string | null
required
status
enum<string>
required
Available options:
pending,
drafting,
draft,
draft_failed,
skipped,
queued,
sending,
sent,
send_failed
task_run_id
string<uuid> | null
required
to_email
string | null
required
updated_at
string<date-time>
required