Cold OS coldosAPI

API key

The key never leaves your browser. Saved keys are stored in this browser's localStorage so paste-once-run-anywhere works across the portal.

Resource

Enrollments

A contact's run through a single flow.

Endpoints · 5

Read · GET

2

Fetch data — accept query filters, return JSON. Read-only and idempotent.

Create · POST

2

Create new records. Send a JSON body; the response is the created resource.

POST
Enroll a contact
/v1/enrollments
/v1/enrollments
Enrolls a contact in a flow at the start node. Refuses if the contact is already in an active enrollment for the same flow (returns the existing row instead).
POST
Force the next step now
/v1/enrollments/{id}/run-now
/v1/enrollments/{id}/run-now
Sets `next_run_at = now()` on an active enrollment. The 60-second tick will pick it up immediately.

Delete · DELETE

1

Destructive — removes the record. Requires a *:write scope.

DELETE
Unenroll (terminate) an enrollment
/v1/enrollments/{id}
/v1/enrollments/{id}
Marks the enrollment as terminal with `exit_reason: "manual"`.

Object shape

The enrollments object

Enrollments object

{
  "id": "01HZS3K8YV0E5Q9P2R7XJF6E2B",
  "flow_id": "01HZS1Q4XK9R2YQX9F7F1ZQE3T",
  "contact_id": "c2a8a93a-2f1c-4c5b-8f3d-9c1e3a8b5d12",
  "status": "active",
  "current_node_id": "node_email_2",
  "next_run_at": "2026-05-02T09:00:00.000+05:30",
  "enrolled_by": "b1f2c3d4-5678-90ab-cdef-1234567890ab",
  "enrolled_at": "2026-04-30T12:15:00.000+05:30",
  "exit_reason": null
}

Was this page helpful?

Your vote stays in this browser. We'll use it to prioritise rewrites.