v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Basic

Enroll a contact in a sequence

Enroll a contact into a sequence using the specified user ID and sequence details.

post/automation/sequences/2026-03/enrollments

Query parameters

userIdstring required

Request body

contactIdstring required

The unique identifier of the contact to be enrolled in the sequence.

senderAliasAddressstring

The alias email address used by the sender when enrolling the contact.

senderEmailstring required

The email address of the sender enrolling the contact in the sequence.

sequenceIdstring required

The unique identifier of the sequence in which the contact will be enrolled.

Response

successful operation

enrolledAtstring date-time required

The date and time when the contact was enrolled in the sequence.

idstring required

The unique identifier for the sequence enrollment.

toEmailstring required

The email address of the contact enrolled in the sequence.

updatedAtstring date-time required

The date and time when the sequence enrollment was last updated.