PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

Get a contact's sequence state GETEnroll a contact in a sequence POSTStop a contact's open sequence POSTPause a contact's active sequence for a human POSTResume a contact's paused sequence POSTList sequences GETCreate a sequence POSTGet a sequence GETUpdate a sequence PATCHSequence stats GETList sequence enrollments GETArchive a sequence POSTBulk-stop enrollments POSTBulk-pause enrollments POST
Sequences

Stop a contact's open sequence

Optional sequenceId only stops that sequence; otherwise lane (default SALES).

POST
/contacts/{contactId}/sequence/stop

Optional sequenceId only stops that sequence; otherwise lane (default SALES).

Authorization

x-api-key<token>

In: header

Path Parameters

contactId*string

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).

reason?string
Default"MANUAL"

Value in

  • "REPLIED"
  • "PURCHASED"
  • "BOOKED"
  • "DECLINED"
  • "OPTED_OUT"
  • "SUPPORT_OPEN"
  • "OUTRANKED"
  • "DEAL_WON"
  • "DEAL_LOST"
  • "CONTACT_MERGED"
  • "MANUAL"
sequenceId?string

Only stop if the open enrollment is in this sequence.

lane?SequenceLane

Lane when sequenceId is omitted. Defaults to SALES.

Value in

  • "SALES"
  • "CLIENT"