sequences

Preview one step for one contact with the waiting changes

The step as the contact would get it once the change set is applied, applying nothing and saving nothing. Nothing is written while the changes leave the step's words as they are or the contact keeps the words they have (changed false), or when another contact of candidate_record_ids is offered in place of one the changes do not reach. A step the agent writes is written again from the changes, spending one of the day's free previews per step written; the words 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.

post/sequences/{sequence_id}/changes/step-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}/changes/step-preview/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

sequence_idstring uuid required

Request body

candidate_record_idsstring[]

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.

record_idstring uuid required

The contact the step is shown for.

step_idstring uuid required
writeboolean

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

changedboolean 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.

reachesboolean

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_atstring date-time nullable

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

suggested_record_idstring uuid nullable

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

Changes

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