Sign in
Sequences

Enroll contacts in a sequence

Enroll one or more contacts into a sequence. Contacts already enrolled are skipped.

post/v1/sequences/{sequenceId}/enroll

Path parameters

sequenceIdstring required

Request body

contactIdsstring[] required
channelIdsstring[]

Optional. Auto-detected if not provided.

Response

Enrollment results

successboolean
enrolledinteger

Number of contacts successfully enrolled

failedinteger

Number that failed (already enrolled, or no subscribed channel on the sequence platform)

Changes

No recorded changes to this endpoint across all 26 revisions of this API.