v93

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

Enroll subscribers in sequence

Manually enrolls active subscribers into a sequence by email or subscriber ID, starting at the first step or a specific node.

post/sequences/{sequenceId}/enroll

Path parameters

sequenceIdstring required

Sequence ID.

Request body

emailsstring[]

Subscriber emails to enroll. Combined with subscriberIds, up to 500 per request.

subscriberIdsstring[]

Subscriber IDs to enroll. Combined with emails, up to 500 per request.

targetNodeIdstring

Node to start enrollment at. Defaults to the first step after the trigger. Cannot be a trigger node.

Response

Enrollment completed

successboolean
enrolledinteger

Number of subscribers enrolled.

skippedinteger

Subscribers skipped because they are inactive or already enrolled.

notFoundstring[]

Emails that did not match any subscriber.

targetNodeIdstring

Node where enrollment starts.

scheduledForstring date-time

When enrolled subscribers process their first step.

Example response

{
  "success": true
}