sequences

Render a step for one contact

Render one step exactly as one contact would receive it. On an agent-written step this shows the sample already saved for that contact and step when there is one; otherwise the agent writes the contact's whole sequence as a free preview, the way the real first send does, answers with this step and saves the others as samples. With fresh it writes the contact's whole sequence again instead of showing what was saved; a thread marked Looks good still shows the words that will send. With write false it writes nothing: it shows what is saved, and with nothing saved answers written false, as the Builder does when a contact is picked. Each step it writes counts against the workspace's daily preview allowance. Without mailbox_id, the sender's variables are filled in as the sequence's first sender's, the sender a preview writes as. With mix above 0, a typed step's rotations pick another combination of their versions, to read the email the way other contacts get it; 0 is the contact's own.

get/sequences/{sequence_id}/steps/{step_id}/preview/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/sequences/{sequence_id}/steps/{step_id}/preview/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

sequence_idstring uuid required
step_idstring uuid required

Query parameters

record_idstring uuid required
mailbox_idstring uuid nullable
freshboolean

Write this contact's messages again rather than show the ones already saved, as when someone asks for the emails to be written again.

writeboolean

False shows only what is already written for this contact and never writes or spends a preview; with nothing written the answer has written false.

mixinteger

0 shows each rotation's version as this contact gets it; another number picks another combination, as other contacts get it.

Response

Successful Response

agent_writtenboolean

The agent wrote this for the contact. A preview is one draft; the real send is written fresh, unless approved.

approvedboolean

The words were marked Looks good, with the contact's thread on the AI writing tab or as this one email from the Builder, and still stand, so they are what sends. They stop standing, and the agent writes the step fresh, once the agent's writing or the contact's row changes.

bodystring required
in_threadboolean required
is_sampleboolean
message_idstring uuid nullable

The agent's message these words are, on an agent-written step: the sample on screen, or the one marked Looks good. The looks-good route takes it back as message_id, so a mark lands only on the words that were read.

missing_columnsstring[] required
pinnedboolean

The words are pinned for this contact by a person (their own edit) or by the approval queue, and send exactly as they are. A thread marked Looks good is approved instead.

sample_created_atstring date-time nullable
sample_versioninteger nullable
subjectstring required
waiting_for_approvalboolean

This contact's message at this step waits for a person's approval on its Tasks card, where its words are changed, approved or rejected. Set by the preview route; false once the card is decided, or when the step never asked.

writtenboolean

False only when the preview was asked to write nothing and nothing is written for this contact at this step yet: subject and body are empty.

Changes

No recorded changes to this operation across all 1 revision of this API.