Sequences API
POST /api/v1/sequences/{id}/enrollments
Starts contacts on a sequence. Requires the write:sequences scope, and also send:emails when the sequence's sendMode is SEND.
Request
POST /api/v1/sequences/cmq2seqn0alk34567890/enrollments HTTP/1.1
Host: agentlyleads.com
Authorization: Bearer alk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
{ "contactIds": ["cmq2cont0alk34567890", "cmq2cont1alk34567890"], "asUserEmail": "kevin@example.com" }| Field | Required | Notes |
|---|---|---|
contactIds | yes | 1 to 1000 contact IDs |
asUserEmail | no | The workspace member whose mailbox the email steps go out from. Defaults to the workspace owner |
Response (200)
{ "sequenceId": "cmq2seqn0alk34567890", "enrolled": 1, "skipped": 1 }Contacts are skipped, not refused, when they have no email address, their address is suppressed, they are already on this sequence, or the ID is not a contact in your workspace. That makes a retry safe.
An archived sequence returns 409; unarchive it in the app first.