Enroll a contact in a sequence
POST
/automation/v4/sequences/enrollments https://api.hubapi.com
Enroll a contact into a sequence using the specified user ID and sequence details.
Parameters
query Query Parameters
| Name | Type |
|---|---|
userId
required
The ID of the user enrolling the contact in the sequence | string |
Request Body
application/json
required
interface PublicSequenceEnrollmentRequest {
contactId: string;
senderAliasAddress?: string;
senderEmail: string;
sequenceId: string;
}
contactId: string;
senderAliasAddress?: string;
senderEmail: string;
sequenceId: string;
}
Responses
200 application/json
successful operation
interface PublicSequenceEnrollmentLiteResponse {
enrolledAt: string;
id: string;
toEmail: string;
updatedAt: string;
}
enrolledAt: string;
id: string;
toEmail: string;
updatedAt: string;
}
default */*
An error occurred.
interface Error {
category: string;
context?: { };
correlationId: string;
errors?:ErrorDetail [];
links?: { };
message: string;
subCategory?: string;
}
category: string;
context?: { };
correlationId: string;
errors?:
links?: { };
message: string;
subCategory?: string;
}