Sign in
Sequences

Start live sequence test

Runs real sequence actions for one active subscriber. Emails are marked as tests. Requires sequences:activate and subscribers:read. Does not enable the sequence or record a trigger event. Ordinary failure retries are disabled; stalled-job recovery can replay actions after worker loss. Completed side effects are not rolled back. Inspect before starting another run.

post/sequences/{sequenceId}/test-runs

Path parameters

sequenceIdstring required

Request body

subscriberIdstring required

Active subscriber in the same company with an email address.

speedMultiplierinteger

Delay acceleration. Existing live-test wait caps still apply.

customVariablesobject

Trigger event properties available as event.* in sequence actions. Supports nested objects and arrays. Omit or use an empty object for no event properties. Null is invalid. No event is recorded and subscriber attributes are not changed by supplying this object.

Example request

{
  "customVariables": {
    "cart_id": "cart_123",
    "event_ids": [
      "event_1",
      "event_2"
    ]
  }
}

Response

Sequence test run.

Changes

Changed in 1 of the 135 revisions of this API.1