Enroll a contact in a sequence
A higher-priority sequence replaces the open enrollment in the same lane (which stops with OUTRANKED). Equal or lower priority leaves the open one in place. Contacts under 18 without guardian consent are refused. A contact can be in one SALES and one CLIENT sequence at the same time.
A higher-priority sequence replaces the open enrollment in the same lane (which stops with OUTRANKED). Equal or lower priority leaves the open one in place. Contacts under 18 without guardian consent are refused. A contact can be in one SALES and one CLIENT sequence at the same time.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Provide sequenceId or sequenceKey.
Response Body
application/json
curl -X POST "https://example.com/contacts/string/sequence/enroll" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "result": "enrolled", "enrollment": { "id": "string", "sequenceId": "string", "contactId": "string", "opportunityId": "string", "lane": "SALES", "status": "ACTIVE", "stopReason": "REPLIED", "currentStep": 0, "lastStepAt": "2019-08-24T14:15:22Z", "pausedAt": "2019-08-24T14:15:22Z", "enrolledAt": "2019-08-24T14:15:22Z", "endedAt": "2019-08-24T14:15:22Z", "sequence": { "id": "string", "key": "string", "name": "string", "priority": 0 } } }}Get a contact's sequence state GET
Open enrollments by lane (`open.SALES`, `open.CLIENT`) and recent ended enrollments. Deprecated SALES-shaped fields (`status`, `sequenceId`, `sequenceKey`, `currentStep`, `enrollment`) stay at the top level for one release. `lane` selects which lane fills those deprecated fields (default SALES).
Stop a contact's open sequence POST
Optional sequenceId only stops that sequence; otherwise lane (default SALES).
Planeward Docs