Bloss Docs

Move a creator group in the brand's order

Developers
POST
/brands/{brandId}/creator-groups/{groupId}/move

Move a group to position toIndex (0 = first) in the brand's group order, the order groups are listed in. A creator is in one group at a time, so order decides nobody's pay or trial: a creator left in two groups from before that rule gets the higher group's, which is the only case a move can reprice someone (only a full admin can do that, and not while a payout is being sent) or change their trial. If a group involved sets a trial, this changes which trial its creators are on, live: someone on Trial whose new terms have no trial, or a goal their videos already meet, moves to Active as the change is made (which can pay a referral bonus), or has their window or goal change. A change that would pass anyone needs payouts:write as a full admin; otherwise it's refused with 403 forbidden and details.wouldPassCreatorIds. A dry run adds trialChanges: each creator on Trial whose terms change, with outcome ("passes", "stays_on_trial", "window_reopens", "window_closes", "goal_changes" or "length_changes"), up to 100 listed. With ?dryRun=true nothing is written; the answer adds repriced.

Authorization

bearerAuth groups: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: groups:write

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length
groupId*string

A group id from GET /brands/{brandId}/creator-groups.

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
toIndex*integer

The new position, 0-based. Past the end means last.

Range0 <= value <= 100

Response Body

Success.

application/json
  1. response
moved*boolean

False when the group was already there.

curl -X POST 'https://example.com/api/v1/brands/string/creator-groups/string/move' \  -H 'Content-Type: application/json' \  -d '{  "toIndex": 0}'
{  "moved": true}

Was this page helpful?

Remove creators from a creator group DELETE

Remove creators from a group. They stay in the brand, with no group. Removing someone who isn't in it changes nothing. If the group sets pay, this moves what its creators earn: only a full admin can do it, and not while a payout is being sent. With ?dryRun=true nothing is written: the answer adds `payImpact` (how many creators' group-level pay would change, so their unpaid cycles would be repriced, and for up to 100 of them their group pay before and after; the rates are left out, with `payShown: false`, unless the token can also read money (**Payout settings, cycles and payouts**, full admin)) and fails with the same 403, 404 or 409 the real call would. If a group involved sets a trial, this changes which trial its creators are on, live: someone on Trial whose new terms have no trial, or a goal their videos already meet, moves to Active as the change is made (which can pay a referral bonus), or has their window or goal change. A change that would pass anyone needs `payouts:write` as a full admin; otherwise it's refused with 403 forbidden and `details.wouldPassCreatorIds`. A dry run adds `trialChanges`: each creator on Trial whose terms change, with `outcome` ("passes", "stays_on_trial", "window_reopens", "window_closes", "goal_changes" or "length_changes"), up to 100 listed.

Rename, recolour or describe a creator group PATCH

Change a group's name, colour or description. Send only what changes. A name another group already uses answers 409 conflict. Doesn't change who's in the group, what they're paid or their trial.