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

List sequence enrollments

GET
/sequences/{sequenceId}/enrollments

Authorization

x-api-key<token>

In: header

Path Parameters

sequenceId*string

Query Parameters

status?string

Value in

  • "ACTIVE"
  • "PAUSED"
  • "STOPPED"
  • "COMPLETED"
stopReason?string

Value in

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

Membership id that paused the enrollment.

endedSince?string
Formatdate-time
limit?integer
Rangevalue <= 100
Default50
offset?integer
Range0 <= value
Default0

Response Body

application/json

curl -X GET "https://example.com/sequences/string/enrollments"
{  "data": [    {      "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      }    }  ],  "meta": {    "total": 0,    "limit": 0,    "offset": 0  }}

Sequence stats GET

Open counts plus completed/stopped in the window (default 30 days).

Archive a sequence POST

Archived sequences take no new enrollments; open ones keep running.