Bloss Docs

Delete an unused sign-up link

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

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.

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

Query Parameters

dryRun?string

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

Value in"true""false"

Response Body

Success.

application/json
  1. response
id*string
deleted*boolean
curl -X DELETE 'https://example.com/api/v1/brands/string/onboarding/links/string'
{  "id": "string",  "deleted": true}

Was this page helpful?

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.

Change a sign-up link PATCH

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.