Bloss Docs

Move creators to another creator group

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

Move creators from this group to toGroupId in one step: they leave this group and join that one, their only group. Creators who aren't in this group are skipped. Pay is checked on the net change, so moving between two groups with the same pay moves no money. 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 (creators whose group pay would change).

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
creatorIds*array<>

1–200 creator ids from GET /brands/{brandId}/creators. Ids that aren't this brand's creators are ignored.

Items1 <= items <= 200
toGroupId*string

The group to move them to; another of this brand's groups.

Length1 <= length

Response Body

Success.

application/json
  1. response
moved*number

Creators moved.

requested*number

Creator ids sent.

curl -X POST 'https://example.com/api/v1/brands/string/creator-groups/string/members/move' \  -H 'Content-Type: application/json' \  -d '{  "creatorIds": [    "string"  ],  "toGroupId": "string"}'
{  "moved": 0,  "requested": 0}

Was this page helpful?

Add creators to a creator group POST

Add creators to a group. A creator is in one group at a time, so anyone already in another group moves here: they leave that group, and its pay and trial stop applying to them (`moved` counts them). Adding someone who's already in it changes nothing, so `added` can be lower than `requested`. Adding never puts an Active creator back on Trial. If the group they join or leave sets pay, this moves what they 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.

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.