Skip to main content
POST
Preview one contact's agent-written message, streaming the research

Authorizations

Authorization
string
header
required

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

Path Parameters

sequence_id
string<uuid>
required

Body

application/json

Which message to preview, for which contact.

record_id
string<uuid>
required

The contact: a row of the sequence's audience table.

step_id
string<uuid>
required

An agent-written step of this sequence: the one the result frame carries. The rest of the contact's sequence is written with it.

fresh
boolean
default:false

Write a new message instead of showing the one already written for this step, contact and agent version. Set it when someone asks for another example: without it the same ask the same day is answered from what was written before, so a second ask returns the first message word for word. For a contact the sequence has not written to yet, a fresh write writes the contact's whole sequence again from its first step; it takes the daily preview allowance for each step it writes.

Response

A stream of Server-Sent Events; the final result frame's data is the asked step's preview message.

One message the agent wrote for one contact as a preview.

Nobody receives it. Sender variables such as {{Sender first name}} are left in place: they are filled in for whichever mailbox sends the real message.