Sequences

Enable sequence

Changed on

Activates a sequence and opens it for new enrollments. Activation enforces the same readiness checks returned by simulateSequence; invalid triggers, incomplete steps, disconnected graphs, and archived sequences are rejected without changing status. If it was paused, held subscribers continue from their current step and due waits are queued gradually.

post/sequences/{sequenceId}/enable

Request

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

Path parameters

sequenceIdstring required

Sequence ID

Response

Sequence enabled successfully

successboolean
messagestring
sequenceIdstring
status'draft' | 'active' | 'paused' | 'archived'

Stored lifecycle status. Do not read literally: a sequence can be active while enrollmentPaused blocks new subscribers. Branch on effectiveStatus instead.

enrollmentPausedboolean

Present for enable/disable and enrollment pause/resume actions.

effectiveStatus'draft' | 'live' | 'enrollment_paused' | 'paused' | 'archived'

Resolved run state, and the single field to branch on. live accepts new subscribers and advances existing recipients; enrollment_paused advances existing recipients only; draft, paused, and archived do neither.

acceptsNewEnrollmentsboolean

Whether new subscribers can enter the sequence right now.

processesExistingEnrollmentsboolean

Whether subscribers already inside the sequence keep advancing and receiving steps.

effectiveStatusSummarystring

One plain-language sentence describing the run state, safe to show a user verbatim.

warningsstring[]

Enable only. Non-blocking readiness warnings, such as empty branch paths, a contact_added trigger with no list, which enrolls every contact added to the company, or an email that uses {{webhooks.KEY...}} or {{ai.KEY...}} when no earlier step saves a result under that key, so those tags send empty. Absent when there is nothing to report.

Example response

{
  "success": true,
  "message": "Sequence enabled",
  "sequenceId": "seq_abc123",
  "enrollmentPaused": 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

  • ba3a29c6eb33Revision 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