Sequences

Pause subscribers in a sequence

Changed on

Holds specific contacts on the sequence step they are on. A paused enrollment gets no further steps, keeps its entry event properties and stop-condition snapshots, and still counts as enrolled, so the same contact cannot enter this sequence again while paused. Unsubscribes, bounces, and enrollment cancellation still end it. A wait-for-event step does not react while paused; an event that arrived meanwhile is picked up on resume. Applies immediately with no dry run. An enrollment whose current step is running at that moment is left alone with outcome in_progress; repeat the request shortly. To stop new contacts entering the whole sequence instead, use POST /sequences/{sequenceId}/pause-enrollments.

post/sequences/{sequenceId}/enrollments/pause

Request

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

Path parameters

sequenceIdstring required

Sequence ID

Request body

subscriberIdsstring[]

Subscriber IDs to pause. IDs that match no contact come back in notFound.subscriberIds.

emailsstring[]

Subscriber emails to pause, matched case-insensitively. Emails that match no contact come back in notFound.emails.

reasonstring

Note stored on each paused enrollment and returned as pauseReason by list enrollments.

Example request

{
  "subscriberIds": [
    "sub_abc123"
  ],
  "emails": [
    "ada@example.com"
  ],
  "reason": "Project blocked"
}

Response

Request applied; each targeted enrollment reports its outcome

successboolean required
sequenceIdstring required
messagestring required
pausedCountinteger required

Enrollments paused by this request.

alreadyPausedCountinteger required

Enrollments that were already paused and were left as they were.

inProgressCountinteger required

Enrollments not paused because their current step was running. Repeat the request shortly.

Example response

{
  "success": true,
  "sequenceId": "seq_abc123",
  "enrollments": [
    {
      "enrollmentId": "tok_abc123",
      "subscriberId": "sub_abc123",
      "subscriberEmail": "ada@example.com",
      "currentNodeId": "node_delay_2",
      "status": "paused",
      "pausedAt": "2026-03-02T09:00:00.000Z",
      "outcome": "paused"
    }
  ],
  "notEnrolled": [
    {
      "subscriberId": "sub_def456",
      "email": "grace@example.com"
    }
  ],
  "message": "Paused 1 enrollment.",
  "pausedCount": 1
}

Changes