Bloss Docs

Delete an onboarding flow

Developers
DELETE
/brands/{brandId}/onboarding/flows/{flowId}

Delete a flow for good, with its tasks, forms and every submission (answers, signed agreements, history). Creators who already joined stay in the brand. Its links stop working: a link a creator joined through or a referral payout points at is kept but switched off; the rest are deleted, and so are pending invitations to the flow. When the flow has submissions, confirmName must be the flow's exact name. Pausing or archiving keeps everything. Preview with dryRun to see what would be erased.

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
confirmName?|

The flow's name, required when it has submissions.

Response Body

Success.

application/json
  1. response
id*string
name*string
submissions*number

Submissions erased.

signed*number

Signed agreements erased.

links*number

Links deleted or switched off.

curl -X DELETE 'https://example.com/api/v1/brands/string/onboarding/flows/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "name": "string",  "submissions": 0,  "signed": 0,  "links": 0}

Was this page helpful?

List agreement templates with their text GET

The brand's agreement templates, as on Onboarding › Agreement templates, by name: the published text creators sign (or a link to the uploaded PDF, valid 10 minutes) and the flows that use each. Filter with `agreementId` from a flow's agreement task.

Change a flow's draft: tasks and settings PATCH

Save changes to a flow's draft, as the flow editor does. Creators see nothing until the flow is published (brand.onboarding.flow.publish). Send `revision` and only the parts that change: `tasks` replaces the whole task list (in order, at most 20), each setting replaces that setting. Read the current draft with brand.onboarding.flow.get. The draft's `revision` as you last read it. If anyone has saved the draft since, nothing is saved and the call answers 409 conflict with `details.currentRevision`: read it again, reapply your change, and retry. A task pointing at a form of another flow, another brand's agreement or an unknown group is refused (400). An archived flow can't be edited (409). Returns the new revision, the saved tasks (with the ids made for new ones) and what still blocks publishing.