Bloss Docs

Change a sign-up link

Developers
PATCH
/brands/{brandId}/onboarding/links/{linkId}

Change a flow link's label, max uses, expiry, on/off switch or default group. Send only what changes; null clears a value. Turning a link off is how you retire one that's been used. The creator a link credits for referrals is money: change it with brand.onboarding.link.referrer.set.

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
linkId*string

A link id from a flow's links (GET .../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 PATCH 'https://example.com/api/v1/brands/string/onboarding/links/string' \  -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?

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.

Get a submission's signed agreements GET

One creator's agreement signatures with download links for the signature image (drawn signatures only) and the signed PDF. Links work for 10 minutes; call again for fresh ones.