Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Workflows::Run

Enroll Contact (Create Run)

Manually enroll a contact into a workflow, starting a new run immediately. The workflow must be enabled (status: live) — an unenabled workflow returns 422. The contact must belong to the same workspace.

Some step types are skipped at enrollment rather than executed — notably page (show_page_step) and internal sequence/plumbing steps, which only make sense inside a funnel. This list is non-exhaustive; standalone automations run the action and split steps documented under Workflows::Step.

post/workflows/{workflow_id}/runs

Path parameters

workflow_idstring required

Integer id or obfuscated public_id of the workflow.

Request body

Example request

{
  "run": {
    "contact_id": "CtAbcd",
    "skip_communication": false
  }
}

Response

Created

idinteger

Run ID

public_idstring nullable

Obfuscated run ID

workflow_idinteger

Integer ID of the parent workflow

contact_idinteger nullable

Raw integer ID of the enrolled contact

current_step_idinteger nullable

Raw integer ID of the step the run is currently at. Null when not at a step.

event_idinteger nullable

Raw integer ID of the triggering event that started this run, if any.

typestring nullable

STI type column. Always null for standard automation runs (the only subtype the list endpoint returns).

status'active' | 'paused' | 'completed' | 'canceled'

Derived execution status.

skip_communicationboolean

When true, communication steps (send email, etc.) are skipped for this run.

completed_atstring date-time nullable

Timestamp when the run completed. Null if still in progress.

paused_atstring date-time nullable

Timestamp when the run was last paused. Null if never paused.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": 501,
  "public_id": "RnXxYz",
  "workflow_id": 101,
  "contact_id": 9001,
  "current_step_id": null,
  "event_id": null,
  "type": null,
  "status": "completed",
  "skip_communication": false,
  "completed_at": "2025-06-02T10:30:00.000Z",
  "paused_at": null,
  "created_at": "2025-06-01T09:00:00.000Z",
  "updated_at": "2025-06-02T10:30:00.000Z"
}