Bloss Docs

Activate, pause or archive a flow

Developers
POST
/brands/{brandId}/onboarding/flows/{flowId}/status

Set a flow's status. "active": its links take new creators (refused with 400 and details.problems until the live version is complete: to launch a flow that was never published, use brand.onboarding.flow.publish with goLive). "paused": links stop taking new creators; creators partway through carry on. "archived": hidden, and it can't be edited or get links; set it active or paused to restore it. Preview with dryRun.

Authorization

bearerAuth onboarding:write
headerAuthorizationBearer <token>

Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, onboarding:read, onboarding:signatures, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read, groups:write, videos:write, onboarding:write, sync:write, payouts:write.

Scope: onboarding:write

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length
flowId*string

A flow id from GET /brands/{brandId}/onboarding/flows.

Length1 <= length

Query Parameters

dryRun?string

"true": run every check and return { dryRun: true, wouldChange } without changing anything.

Value in"true""false"

Request Body

application/json
  1. body
status*string
Value in"active""paused""archived"

Response Body

Success.

application/json
  1. response
id*string
status*string
curl -X POST 'https://example.com/api/v1/brands/string/onboarding/flows/string/status' \  -H 'Content-Type: application/json' \  -d '{  "status": "active"}'
{  "id": "string",  "status": "string"}

Was this page helpful?

Publish a flow's draft POST

Make the draft live in one go: its tasks and settings, the draft of every form its tasks use (each renamed after its task) and of every agreement they use, each as a new version when it changed. `goLive: true` also activates a draft or paused flow, and gives a flow with no links its first one ("Main link", returned as `link`). Refused with 400 and `details.problems` (taskId, message) while anything isn't ready; an archived flow answers 409. Creators partway through move onto the new version for the tasks they haven't finished (`updatedSubmissions`); one whose remaining tasks were all removed finishes, joining or waiting for approval. Preview with dryRun: whether anything would change, what blocks it, and how many open submissions would move. A brand key can't take a flow with no links live (403): the first link records who made it.

Rename a flow or change its note PATCH

Change a flow's name or its internal note, straight away (no publish needed). The settings creators feel (completion mode, join group, welcome and finish messages) are part of the draft: change them with brand.onboarding.flow.draft.update, then publish. To change only the join group straight away, use brand.onboarding.flow.join-group.set.