POST/v1/flows/{id}/unenrollflows:write

Bulk unenroll contacts

Marks the given contacts' active+paused enrollments as terminal with `exit_reason: "manual"`. Capped at 500 per call.

Run a request

POST/v1/flows/{id}/unenroll

Base URL

Path

idrequired

Request body (JSON)

Resolved URL

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

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

Parameters

Path parameters

idstringrequired
Flow id.

Body parameters

contact_idsuuid[]required
Up to 500 contact ids.

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 POST "https://coldos.justgotwyrd.com/api/v1/flows/{id}/unenroll" \
  -H "Authorization: Bearer $COLD_OS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "contact_ids": [
        "c2a8a93a-2f1c-4c5b-8f3d-9c1e3a8b5d12"
      ]
    }'

Response · 200

{
  "unenrolled": 1,
  "skipped": 0
}

Was this page helpful?

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