Pause Subscribers in a Sequence

POST

api

sequences

{sequenceId}

enrollments

pause

Pause Subscribers in a Sequence

curl --request POST \
  --url https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriberIds": [
    {}
  ],
  "emails": [
    {}
  ],
  "reason": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause"

payload = {
    "subscriberIds": [{}],
    "emails": [{}],
    "reason": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({subscriberIds: [{}], emails: [{}], reason: '<string>'})
};

fetch('https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subscriberIds' => [
        [
                
        ]
    ],
    'emails' => [
        [
                
        ]
    ],
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause"

	payload := strings.NewReader("{\n  \"subscriberIds\": [\n    {}\n  ],\n  \"emails\": [\n    {}\n  ],\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscriberIds\": [\n    {}\n  ],\n  \"emails\": [\n    {}\n  ],\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subscriberIds\": [\n    {}\n  ],\n  \"emails\": [\n    {}\n  ],\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "sequenceId": "seq_abc123",
  "pausedCount": 1,
  "alreadyPausedCount": 0,
  "inProgressCount": 0,
  "enrollments": [
    {
      "enrollmentId": "tok_abc123",
      "subscriberId": "sub_abc123",
      "subscriberEmail": "ada@example.com",
      "currentNodeId": "node_delay_2",
      "status": "paused",
      "waitUntil": null,
      "pausedAt": "2026-03-02T09:00:00.000Z",
      "outcome": "paused"
    }
  ],
  "notEnrolled": [],
  "notFound": { "subscriberIds": [], "emails": [] },
  "message": "Paused 1 enrollment."
}

{
  "error": "Provide subscriberIds, emails, or both."
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: sequences:enroll"
}

{
  "error": "Sequence not found"
}

Hold specific contacts on the step they are on, then continue them later with resume subscribers. Use this when a contact’s onboarding should stop for a while, for example while their account is blocked or under review, without cancelling the enrollment or restarting the sequence. A paused enrollment:

Gets no further steps from this sequence until you resume it.
Keeps its step, its entry event properties, and its stop-condition snapshots.
Still counts as enrolled, so the same contact cannot enter this sequence again while paused.
Is still ended by an unsubscribe, a bounce, or cancel enrollments.
Does not react to events until you resume it. If the contact is paused on a wait-for-event step and the event arrives meanwhile, the step continues as soon as you resume them.

The request applies immediately; there is no dry run. Pausing an enrollment that is already paused changes nothing and reports already_paused.

This pauses individual contacts. To stop new contacts from entering the whole sequence while everyone already in it continues, use pause enrollments instead.

Request

string

required

Sequence ID.

array

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

array

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

string

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

Send subscriberIds, emails, or both. Up to 500 targets combined per request.

curl -X POST "https://api.sequenzy.com/api/v1/sequences/seq_abc123/enrollments/pause" \
  -H "Authorization: Bearer seq_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "emails": ["ada@example.com"],
    "reason": "Project blocked"
  }'

sequenzy sequences pause-subscribers seq_abc123 --email ada@example.com --reason "Project blocked"

Outcomes

Every active, waiting, or paused enrollment the targeted contacts have in this sequence is returned in enrollments with one outcome:

Outcome	Meaning
`paused`	Paused by this request.
`already_paused`	Was already paused. Left as it was.
`in_progress`	A step was running for this enrollment at that moment, so it was not paused. Send the same request again shortly. If a worker stopped in the middle of the step, this can take up to 15 minutes to clear.

Contacts that exist but have no enrollment in this sequence are listed in notEnrolled. A contact can have more than one enrollment in a sequence that enrolls per matching field value; every one of them is paused.

Responses

{
  "success": true,
  "sequenceId": "seq_abc123",
  "pausedCount": 1,
  "alreadyPausedCount": 0,
  "inProgressCount": 0,
  "enrollments": [
    {
      "enrollmentId": "tok_abc123",
      "subscriberId": "sub_abc123",
      "subscriberEmail": "ada@example.com",
      "currentNodeId": "node_delay_2",
      "status": "paused",
      "waitUntil": null,
      "pausedAt": "2026-03-02T09:00:00.000Z",
      "outcome": "paused"
    }
  ],
  "notEnrolled": [],
  "notFound": { "subscriberIds": [], "emails": [] },
  "message": "Paused 1 enrollment."
}

{
  "error": "Provide subscriberIds, emails, or both."
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: sequences:enroll"
}

{
  "error": "Sequence not found"
}

Pause Subscribers in a Sequence

curl --request POST \
  --url https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscriberIds": [
    {}
  ],
  "emails": [
    {}
  ],
  "reason": "<string>"
}
'

import requests

url = "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause"

payload = {
    "subscriberIds": [{}],
    "emails": [{}],
    "reason": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({subscriberIds: [{}], emails: [{}], reason: '<string>'})
};

fetch('https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subscriberIds' => [
        [
                
        ]
    ],
    'emails' => [
        [
                
        ]
    ],
    'reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause"

	payload := strings.NewReader("{\n  \"subscriberIds\": [\n    {}\n  ],\n  \"emails\": [\n    {}\n  ],\n  \"reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subscriberIds\": [\n    {}\n  ],\n  \"emails\": [\n    {}\n  ],\n  \"reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/pause")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subscriberIds\": [\n    {}\n  ],\n  \"emails\": [\n    {}\n  ],\n  \"reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "sequenceId": "seq_abc123",
  "pausedCount": 1,
  "alreadyPausedCount": 0,
  "inProgressCount": 0,
  "enrollments": [
    {
      "enrollmentId": "tok_abc123",
      "subscriberId": "sub_abc123",
      "subscriberEmail": "ada@example.com",
      "currentNodeId": "node_delay_2",
      "status": "paused",
      "waitUntil": null,
      "pausedAt": "2026-03-02T09:00:00.000Z",
      "outcome": "paused"
    }
  ],
  "notEnrolled": [],
  "notFound": { "subscriberIds": [], "emails": [] },
  "message": "Paused 1 enrollment."
}

{
  "error": "Provide subscriberIds, emails, or both."
}

{
  "error": "Invalid API key"
}

{
  "error": "API key is missing required scope: sequences:enroll"
}

{
  "error": "Sequence not found"
}

​Request

​Outcomes

​Responses

Request

Outcomes

Responses