POST

api

sequences

{sequenceId}

enrollments

move

Move Sequence Enrollments

curl --request POST \
  --url https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/move \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromNodeId": "<string>",
  "targetNodeId": "<string>",
  "limit": 123,
  "sort": "<string>",
  "subscriberIds": [
    {}
  ],
  "dailyLimit": 123,
  "tags": [
    {}
  ],
  "reason": "<string>",
  "dryRun": true
}
'

import requests

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

payload = {
    "fromNodeId": "<string>",
    "targetNodeId": "<string>",
    "limit": 123,
    "sort": "<string>",
    "subscriberIds": [{}],
    "dailyLimit": 123,
    "tags": [{}],
    "reason": "<string>",
    "dryRun": True
}
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({
    fromNodeId: '<string>',
    targetNodeId: '<string>',
    limit: 123,
    sort: '<string>',
    subscriberIds: [{}],
    dailyLimit: 123,
    tags: [{}],
    reason: '<string>',
    dryRun: true
  })
};

fetch('https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/move', 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/move",
  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([
    'fromNodeId' => '<string>',
    'targetNodeId' => '<string>',
    'limit' => 123,
    'sort' => '<string>',
    'subscriberIds' => [
        [
                
        ]
    ],
    'dailyLimit' => 123,
    'tags' => [
        [
                
        ]
    ],
    'reason' => '<string>',
    'dryRun' => true
  ]),
  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/move"

	payload := strings.NewReader("{\n  \"fromNodeId\": \"<string>\",\n  \"targetNodeId\": \"<string>\",\n  \"limit\": 123,\n  \"sort\": \"<string>\",\n  \"subscriberIds\": [\n    {}\n  ],\n  \"dailyLimit\": 123,\n  \"tags\": [\n    {}\n  ],\n  \"reason\": \"<string>\",\n  \"dryRun\": true\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/move")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fromNodeId\": \"<string>\",\n  \"targetNodeId\": \"<string>\",\n  \"limit\": 123,\n  \"sort\": \"<string>\",\n  \"subscriberIds\": [\n    {}\n  ],\n  \"dailyLimit\": 123,\n  \"tags\": [\n    {}\n  ],\n  \"reason\": \"<string>\",\n  \"dryRun\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"fromNodeId\": \"<string>\",\n  \"targetNodeId\": \"<string>\",\n  \"limit\": 123,\n  \"sort\": \"<string>\",\n  \"subscriberIds\": [\n    {}\n  ],\n  \"dailyLimit\": 123,\n  \"tags\": [\n    {}\n  ],\n  \"reason\": \"<string>\",\n  \"dryRun\": true\n}"

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

{
  "success": true,
  "sequenceId": "seq_abc123",
  "dryRun": false,
  "fromNodeId": "node_delay_2",
  "targetNodeId": "node_email_3",
  "sort": "wait_until_asc",
  "requestedLimit": 180,
  "effectiveLimit": 180,
  "matchedCount": 4320,
  "movedCount": 180,
  "remainingCount": 4140,
  "skippedCount": 0,
  "dailyLimit": 500,
  "movedInWindow": 0,
  "dailyRemaining": 320,
  "enqueuedCount": 180,
  "enqueueErrors": [],
  "tagResult": {
    "tags": ["wave-3-released"],
    "updated": 180,
    "unchanged": 0,
    "failed": 0,
    "failures": []
  },
  "enrollments": [
    {
      "tokenId": "tok_abc123",
      "subscriberId": "sub_abc123",
      "subscriberEmail": "customer@example.com",
      "status": "active",
      "enrollmentKey": "__default__"
    }
  ],
  "hasMore": true,
  "message": "Moved 180 enrollments. 4140 still wait on the source step; repeat this request to release more. 320 left under the daily limit."
}

{
  "error": "fromNodeId branches into multiple next steps, so targetNodeId is required"
}

{
  "error": "Invalid API key"
}

{
  "error": "Tagging moved enrollments requires the subscribers:tag scope. Omit `tags` to move them without tagging."
}

{
  "error": "Sequence not found"
}

Move Sequence Enrollments

Release a bounded batch of contacts off one sequence step and onto another, keeping their enrollment intact. Use this when you want the next N contacts waiting on a delay to continue early: pace a launch, drain a hold step, or push one wave past a wait without touching the graph. You could approximate this by cancelling the enrollments and re-enrolling them at the target step, but that throws away the enrollment’s entry event properties, its stop-condition entry snapshots, and its original start date, and it is refused outright while the sequence has new enrollment paused. Moving does none of those things. Moved contacts become active on the target step right away, so the sequence emails them as soon as a worker picks them up. Every bulk target defaults to a dry run: pass dryRun: false to actually move them.

Request

string

required

Sequence ID.

string

required

Node ID the contacts are currently sitting on. Read it from currentNodeId on list enrollments.

string

Node ID to move them onto. Defaults to the source step’s only next step, and is required when that step branches or is terminal. Cannot be the trigger node.

number

Maximum enrollments to move in this call. Defaults to 100, maximum 500.

string

Which enrollments to take first: wait_until_asc (default), wait_until_desc, enrolled_at_asc, or enrolled_at_desc. The default takes the contacts that have been waiting longest for their next step.

array

Optional narrowing filter: only move these subscribers, up to 500.

number

Guardrail. Refuses to move more than this many enrollments onto targetNodeId in a rolling 24 hours, counting the moves recorded by earlier calls. The response reports movedInWindow and dailyRemaining so a paced release can resume the next day.

array

Tag names applied to the moved contacts so the released wave stays identifiable. The tags must already exist, and this requires the subscribers:tag scope. Applying them never enrolls contacts in tag_added sequences.

string

Note stored on every moved enrollment and returned as moveReason by list enrollments.

boolean

When true (the default), reports which enrollments would move without moving them. Pass false to apply.

curl -X POST "https://api.sequenzy.com/api/v1/sequences/seq_abc123/enrollments/move" \
  -H "Authorization: Bearer seq_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "fromNodeId": "node_delay_2",
    "targetNodeId": "node_email_3",
    "limit": 180,
    "dailyLimit": 500,
    "tags": ["wave-3-released"],
    "reason": "Wave 3",
    "dryRun": false
  }'

Pacing a release

Each call is bounded on purpose, so it is never drained automatically. When the response reports remainingCount above zero, send the same request again to release the next batch. Combine limit with dailyLimit to spread a large backlog over several days without tracking the running total yourself. Active enrollments, enrollments a worker is currently mid-step on, and enrollments parked awaiting double opt-in are never moved. Active tokens may still have older queue work, so only safely parked waiting tokens can be repositioned. Excluded enrollments are reported in skippedCount and omitted from matchedCount.

# The CLI is deliberately one batch per invocation too.
sequenzy sequences move-enrollments seq_abc123 --from-node node_delay_2 --limit 180 --apply

Responses

{
  "success": true,
  "sequenceId": "seq_abc123",
  "dryRun": false,
  "fromNodeId": "node_delay_2",
  "targetNodeId": "node_email_3",
  "sort": "wait_until_asc",
  "requestedLimit": 180,
  "effectiveLimit": 180,
  "matchedCount": 4320,
  "movedCount": 180,
  "remainingCount": 4140,
  "skippedCount": 0,
  "dailyLimit": 500,
  "movedInWindow": 0,
  "dailyRemaining": 320,
  "enqueuedCount": 180,
  "enqueueErrors": [],
  "tagResult": {
    "tags": ["wave-3-released"],
    "updated": 180,
    "unchanged": 0,
    "failed": 0,
    "failures": []
  },
  "enrollments": [
    {
      "tokenId": "tok_abc123",
      "subscriberId": "sub_abc123",
      "subscriberEmail": "customer@example.com",
      "status": "active",
      "enrollmentKey": "__default__"
    }
  ],
  "hasMore": true,
  "message": "Moved 180 enrollments. 4140 still wait on the source step; repeat this request to release more. 320 left under the daily limit."
}

{
  "error": "fromNodeId branches into multiple next steps, so targetNodeId is required"
}

{
  "error": "Invalid API key"
}

{
  "error": "Tagging moved enrollments requires the subscribers:tag scope. Omit `tags` to move them without tagging."
}

{
  "error": "Sequence not found"
}

Move Sequence Enrollments

curl --request POST \
  --url https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/move \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fromNodeId": "<string>",
  "targetNodeId": "<string>",
  "limit": 123,
  "sort": "<string>",
  "subscriberIds": [
    {}
  ],
  "dailyLimit": 123,
  "tags": [
    {}
  ],
  "reason": "<string>",
  "dryRun": true
}
'

import requests

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

payload = {
    "fromNodeId": "<string>",
    "targetNodeId": "<string>",
    "limit": 123,
    "sort": "<string>",
    "subscriberIds": [{}],
    "dailyLimit": 123,
    "tags": [{}],
    "reason": "<string>",
    "dryRun": True
}
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({
    fromNodeId: '<string>',
    targetNodeId: '<string>',
    limit: 123,
    sort: '<string>',
    subscriberIds: [{}],
    dailyLimit: 123,
    tags: [{}],
    reason: '<string>',
    dryRun: true
  })
};

fetch('https://api.sequenzy.com/api/v1/sequences/{sequenceId}/enrollments/move', 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/move",
  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([
    'fromNodeId' => '<string>',
    'targetNodeId' => '<string>',
    'limit' => 123,
    'sort' => '<string>',
    'subscriberIds' => [
        [
                
        ]
    ],
    'dailyLimit' => 123,
    'tags' => [
        [
                
        ]
    ],
    'reason' => '<string>',
    'dryRun' => true
  ]),
  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/move"

	payload := strings.NewReader("{\n  \"fromNodeId\": \"<string>\",\n  \"targetNodeId\": \"<string>\",\n  \"limit\": 123,\n  \"sort\": \"<string>\",\n  \"subscriberIds\": [\n    {}\n  ],\n  \"dailyLimit\": 123,\n  \"tags\": [\n    {}\n  ],\n  \"reason\": \"<string>\",\n  \"dryRun\": true\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/move")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fromNodeId\": \"<string>\",\n  \"targetNodeId\": \"<string>\",\n  \"limit\": 123,\n  \"sort\": \"<string>\",\n  \"subscriberIds\": [\n    {}\n  ],\n  \"dailyLimit\": 123,\n  \"tags\": [\n    {}\n  ],\n  \"reason\": \"<string>\",\n  \"dryRun\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"fromNodeId\": \"<string>\",\n  \"targetNodeId\": \"<string>\",\n  \"limit\": 123,\n  \"sort\": \"<string>\",\n  \"subscriberIds\": [\n    {}\n  ],\n  \"dailyLimit\": 123,\n  \"tags\": [\n    {}\n  ],\n  \"reason\": \"<string>\",\n  \"dryRun\": true\n}"

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

{
  "success": true,
  "sequenceId": "seq_abc123",
  "dryRun": false,
  "fromNodeId": "node_delay_2",
  "targetNodeId": "node_email_3",
  "sort": "wait_until_asc",
  "requestedLimit": 180,
  "effectiveLimit": 180,
  "matchedCount": 4320,
  "movedCount": 180,
  "remainingCount": 4140,
  "skippedCount": 0,
  "dailyLimit": 500,
  "movedInWindow": 0,
  "dailyRemaining": 320,
  "enqueuedCount": 180,
  "enqueueErrors": [],
  "tagResult": {
    "tags": ["wave-3-released"],
    "updated": 180,
    "unchanged": 0,
    "failed": 0,
    "failures": []
  },
  "enrollments": [
    {
      "tokenId": "tok_abc123",
      "subscriberId": "sub_abc123",
      "subscriberEmail": "customer@example.com",
      "status": "active",
      "enrollmentKey": "__default__"
    }
  ],
  "hasMore": true,
  "message": "Moved 180 enrollments. 4140 still wait on the source step; repeat this request to release more. 320 left under the daily limit."
}

{
  "error": "fromNodeId branches into multiple next steps, so targetNodeId is required"
}

{
  "error": "Invalid API key"
}

{
  "error": "Tagging moved enrollments requires the subscribers:tag scope. Omit `tags` to move them without tagging."
}

{
  "error": "Sequence not found"
}

​Move Sequence Enrollments

​Request

​Pacing a release

​Responses

Move Sequence Enrollments

Request

Pacing a release

Responses