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

Bulk-pause enrollments

Body is enrollmentIds or a filter. More than 200 matching active rows returns `{ jobId }` instead of `{ paused }`.

POST
/sequences/{sequenceId}/enrollments/bulk-pause

Body is enrollmentIds or a filter. More than 200 matching active rows returns { jobId } instead of { paused }.

Authorization

x-api-key<token>

In: header

Path Parameters

sequenceId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/sequences/string/enrollments/bulk-pause" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "paused": 0,    "jobId": "string"  }}

Bulk-stop enrollments POST

Body is enrollmentIds or a filter, plus reason (default MANUAL). More than 200 matching rows returns `{ jobId }` instead of `{ stopped }`.

Get a bulk job GET

Poll until status is SUCCEEDED, FAILED, or CANCELLED. Jobs are workspace-scoped.

enrollmentIds?array<string>
status?string

Value in

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

Value in

  • "REPLIED"
  • "PURCHASED"
  • "BOOKED"
  • "DECLINED"
  • "OPTED_OUT"
  • "SUPPORT_OPEN"
  • "OUTRANKED"
  • "DEAL_WON"
  • "DEAL_LOST"
  • "CONTACT_MERGED"
  • "MANUAL"
pausedBy?string
endedSince?string
Formatdate-time
reason?SequenceStopReason

Value in

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