Skip to main content
POST
Preview one step for one contact with the waiting changes

Authorizations

X-API-Key
string
header
required

Path Parameters

sequence_id
string<uuid>
required

Body

application/json

One step for one contact, as a person's waiting changes would have it.

changes
SequenceChangesSchema · object
required

A person's waiting changes to a live sequence, as Review changes holds them.

record_id
string<uuid>
required

The contact the step is shown for.

step_id
string<uuid>
required
candidate_record_ids
string<uuid>[]

Contacts the Preview may show instead, in the order it lists them. When the changes do not reach record_id and one of these they do reach, that one is offered as suggested_record_id and nothing is written.

Maximum array length: 50
write
boolean
default:true

False answers whether the changes change this step and reach the contact, and writes nothing for a step the agent writes: no preview is spent. A typed step is filled in either way, which costs nothing.

Response

Successful Response

What a step's Preview shows of the waiting changes for one contact.

changed
boolean
required

Whether the waiting changes change this step's words for this contact. False: the step reads as it does live (the changes touch something else, or the contact keeps the words they have: a person's own, words a person approved or a send holds, or, for a lesson, words already written for them or a thread marked Looks good), and nothing was written.

message
RenderedMessageReadSchema · object | null

The step as the contact would get it once the changes are live. A step the agent writes is written again from the changes, spending one of the day's free previews per step written, and is saved nowhere: it names no message_id. The words written are kept for 30 minutes for this contact and these changes, so another step's Preview and a test send read them and spend nothing.

reaches
boolean
default:true

Whether the changes reach this contact: false once this step has gone to them, when they are past it or down another branch, when they are done with the sequence and the changes do not carry them on, or when they are not in it.

sent_at
string<date-time> | null

When this step went to the contact, when it has.

suggested_record_id
string<uuid> | null

A contact of candidate_record_ids the changes do reach, offered in place of record_id, which they do not; message is then empty.