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

Sequence stats

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

GET
/sequences/{sequenceId}/stats

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

Authorization

x-api-key<token>

In: header

Path Parameters

sequenceId*string

Query Parameters

days?integer
Range1 <= value <= 365
Default30

Response Body

application/json

curl -X GET "https://example.com/sequences/string/stats"
{  "data": {    "days": 0,    "active": 0,    "paused": 0,    "completed": 0,    "stopped": 0,    "completionRate": 0,    "stopReasons": [      {        "reason": "REPLIED",        "count": 0      }    ],    "topStopReason": "REPLIED"  }}

Update a sequence PATCH

Set `archived` to stop new enrollments; open ones keep running.

List sequence enrollments GET

Next Page