v93

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB

Sequences

Pause sequence enrollments

Stops new subscribers from entering an active sequence while current recipients continue through the sequence.

post/sequences/{sequenceId}/pause-enrollments

Path parameters

sequenceIdstring required

Sequence ID

Response

Sequence enrollments paused 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.

Example response

{
  "success": true,
  "message": "Sequence enabled",
  "sequenceId": "seq_abc123",
  "enrollmentPaused": true
}