Skip to main content
GET
Read a write of one contact's samples

Authorizations

X-API-Key
string
header
required

Path Parameters

sequence_id
string<uuid>
required
run_id
string<uuid>
required

Response

Successful Response

One press of Write the email for one contact, written in the background.

created_at
string<date-time>
required
id
string<uuid>
required

The write, which GET .../sample-runs/{run_id}/ reads.

record_id
string<uuid>
required

The contact's audience row.

sequence_id
string<uuid>
required
state
enum<string>
required

queued and running while the agent writes; done once the step pressed has words, in rendered; failed when nothing was written for it, with error saying why. A failed write's previews go back to today's allowance.

Available options:
queued,
running,
done,
failed
step_id
string<uuid>
required

The step pressed, which rendered shows.

step_ids
string<uuid>[]
required

The steps the write covers, in order: the contact's whole sequence, or the step pressed alone while another of their emails is marked Looks good, or the step pressed when its words were already there.

error
string | null

What to tell a person; null unless failed.

error_code
enum<string> | null

Why it failed: not_written (the agent wrote nothing usable), timed_out, lost (it stopped before it finished), gone (the contact or step changed meanwhile) or error. Null unless failed.

Available options:
not_written,
timed_out,
lost,
gone,
error
finished_at
string<date-time> | null

When it ended; null while open.

rendered
RenderedMessageReadSchema · object | null

The step pressed as the contact would receive it, read when the write is done, as GET /sequences/{sequence_id}/steps/{step_id}/preview/ shows it. Null until then.