Stop a contact's open sequence
Optional sequenceId only stops that sequence; otherwise lane (default SALES).
Optional sequenceId only stops that sequence; otherwise lane (default SALES).
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/contacts/string/sequence/stop" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "stopped": true, "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 } } }}Enroll a contact in a sequence POST
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.
Pause a contact's active sequence for a human POST
A paused enrollment still blocks lower-priority sequences in the same lane. Optional sequenceId or lane (default SALES).
Planeward Docs