Bloss Docs

Set or clear the creator a sign-up link credits

Developers
POST
/brands/{brandId}/onboarding/links/{linkId}/referrer

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.

Authorization

bearerAuth payouts: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: payouts: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

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
creatorId*|

A creator id from GET /brands/{brandId}/creators. Null: the link credits nobody.

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
referrer*|

The creator this link credits for referrals, or null for none.

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

Was this page helpful?

Restore a form version into its draft POST

Copy a published version of a form back into its draft (a new draft revision). Creators see it when the flow is published. Returns the form.

Create a sign-up link for a flow POST

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.