Skip to main content
PATCH
/
api
/
program-executions
/
{id}
/
pause
Pause a running execution
curl --request PATCH \
  --url http://localhost:3000/api/program-executions/{id}/pause \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "programId": "<string>",
  "organizationId": "<string>",
  "audienceId": "<string>",
  "flowId": "<string>",
  "status": "scheduled",
  "totalContacts": 123,
  "contactsCompleted": 123,
  "contactsFailed": 123,
  "contactsPending": 123,
  "contactsInProgress": 123,
  "scheduledStartAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "scheduledStopAt": "<string>",
  "actualStartAt": "<string>",
  "actualEndAt": "<string>",
  "autoPauseRules": [
    {
      "nodeId": "node_abc123",
      "threshold": 100,
      "resetOnResume": true
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Execution ID

Response

id
string
required

Execution ID

programId
string
required

Program ID

organizationId
string
required

Organization ID

audienceId
string
required

Audience ID

flowId
string
required

Flow ID

status
enum<string>
required
Available options:
scheduled,
running,
paused,
paused_no_credits,
paused_threshold,
completed,
stopped,
cancelled
totalContacts
number
required

Total contacts in execution

contactsCompleted
number
required

Contacts completed successfully

contactsFailed
number
required

Contacts failed

contactsPending
number
required

Contacts pending

contactsInProgress
number
required

Contacts currently in progress

scheduledStartAt
string
required

Scheduled start time

createdAt
string
required

Created at

updatedAt
string
required

Updated at

scheduledStopAt
string

Scheduled stop time

actualStartAt
string

Actual start time

actualEndAt
string

Actual end time

autoPauseRules
object[]

Auto-pause rules