Bloss Docs

Create a sign-up link for a flow

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

Add a sign-up link to a flow (not an archived one). Creators who open it start the flow; it only works while the flow is active. Returns the link with its URL to share. Creating a link needs a personal token: a link records who made it, and a brand key has no person behind it.

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

Request Body

application/json
  1. body
label?|

A name for the link, e.g. "Instagram bio". Null clears it.

maxUses?|

How many creators can join through it. Null: unlimited.

expiresAt?|

ISO-8601 instant after which the link stops working. Null: never.

active?boolean

Turn the link on or off.

defaultGroupId?|

A group id from GET .../creator-groups: joiners go in it when the flow sets no join group (the flow's group wins). Null: none.

Response Body

Success.

application/json
  1. response
id*string
flowId*string|null
url*string

The sign-up link to share with creators.

label*string|null
active*boolean

Off: the link doesn't start the flow.

uses*number

Creators who joined through it.

maxUses*|

Null: unlimited.

expiresAt*|

Null: never expires.

defaultGroupId*|

The creator group joiners are put in when the flow sets none (the flow's join group wins).

createdAt*string
curl -X POST 'https://example.com/api/v1/brands/string/onboarding/flows/string/links' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "flowId": "string",  "url": "string",  "label": "string",  "active": true,  "uses": 0,  "maxUses": 0,  "expiresAt": "string",  "defaultGroupId": "string",  "createdAt": "string"}

Was this page helpful?

Set or clear the creator a sign-up link credits POST

Choose which of the brand's creators a flow link credits for referrals, or clear it with null, as the link dialog's referrer does. Moves money: when a creator who joined through the link passes their trial and the brand's referral bonus is on, the referrer named on the link at that moment earns it. So the change also reaches creators who already joined through the link and are still in their trial; creators who already earned a referral payout keep its referrer. The creator must be one of the brand's (400 `bad_creator` otherwise). Full admins only; a brand key can do it. Read the current referrer with brand.invite-codes.list (`referrer`) or a dryRun. With ?dryRun=true nothing is written: the answer shows the referrer before and after, the brand's referral bonus, and how many creators joined through the link, already earned a referral payout, or are still in their trial.

Delete an unused sign-up link DELETE

Delete a flow link nobody has used. A link that has been used (creators joined or started through it, or a referral payout points at it) can't be deleted: it answers 409 conflict (`details.reason` link_used); turn it off with brand.onboarding.links.update instead. Preview with dryRun.