PATCH/v1/flows/{id}flows:write

Update a flow

Editing `send_window_*` / `send_days_of_week` / `timezone` walks active and paused enrollments and recomputes `next_run_at` BACKWARDS only — never pushing a contact into the past.

Run a request

PATCH/v1/flows/{id}

Base URL

Path

idrequired

Request body (JSON)

Resolved URL

PATCHhttps://coldos.justgotwyrd.com/api/v1/flows/{id}

Paste an API key in the bar at the top of the page to enable Execute.

Parameters

Path parameters

idstringrequired
Flow id.

Body parameters

namestringoptional
Display name.
statusstringoptional
draft / active / paused / archived.
draftactivepausedarchived
send_window_startstringoptional
Local-time HH:MM, inclusive lower bound for sends.
send_window_endstringoptional
Local-time HH:MM, exclusive upper bound.
send_days_of_weekinteger[]optional
0=Sunday ... 6=Saturday.
timezonestringoptional
IANA zone (e.g. "Asia/Kolkata").
notify_on_advancebooleanoptional
Send a per-step notification on every advance.

Responses

400Invalid request — see `error.message`.
401Missing or invalid API key.
403Authenticated, but the key lacks the required scope.
404The referenced resource does not exist or is not visible to your key.
429Rate limit exceeded — see `Retry-After`.
500Unexpected server error. Safe to retry with idempotency-key.

Code samples

curl -X PATCH "https://coldos.justgotwyrd.com/api/v1/flows/{id}" \
  -H "Authorization: Bearer $COLD_OS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "status": "active"
    }'

Response · 200

{
  "id": "01HZS1Q4XK9R2YQX9F7F1ZQE3T",
  "name": "APAC mid-market — 5-touch",
  "status": "active",
  "enrolled_count": 312,
  "active_count": 247,
  "send_window_start": "09:00",
  "send_window_end": "18:00",
  "send_days_of_week": [
    1,
    2,
    3,
    4,
    5
  ],
  "timezone": "Asia/Kolkata",
  "notify_on_advance": false,
  "created_at": "2026-04-30T12:00:00.000+05:30"
}

Was this page helpful?

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