Sequences

Simulate sequence

Changed on

Dry-runs a sequence without sending mail or enrolling anyone. Activating does not auto-enroll anyone. Without a subscriber this reports who currently matches and activation readiness errors. Pass subscriberId or email to also walk that stored contact's branch path. Always requires both sequences:read and subscribers:read because results include contact samples.

get/sequences/{sequenceId}/simulate

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sequences/{sequenceId}/simulate
  • Auth
    HTTP bearer

Path parameters

sequenceIdstring required

Sequence ID

Query parameters

subscriberIdstring

Optional stored subscriber to walk through the graph. Do not pass with email.

emailstring email

Optional stored subscriber email to walk through the graph. Do not pass with subscriberId.

limitinteger

How many currently matching contacts to include in the sample. Defaults to 10, maximum 25.

Response

Sequence simulation

successboolean required
sequenceIdstring required
sequenceNamestring
statusstring
sendsMailboolean required
enrollmentobject required

Who currently matches and the confirmation that nobody is auto-enrolled on activate.

pathobject nullable

Walked graph for the optional stored subscriber. emailStepsOnPath counts traversed email nodes; emailsOnPath counts those deliverable for the subscriber's current email and status. Null when none was passed.

Example response

{
  "success": true
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 7be6436bbf9aRevision changes
    • info

      endpoint added