Bloss Docs

Add creators to a creator group

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

Add creators to a group. A creator can be in several groups. Adding someone who's already in it changes nothing, so added can be lower than requested. 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.

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

Response Body

Success.

application/json
  1. response
added*number

Creators newly added.

requested*number

Creator ids sent.

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

Was this page helpful?

The brand's creator groups GET

The brand's creator groups in display order, each with exactly which creators are in it and whether it sets pay. Membership is current, and includes archived creators (their past sets still count in reports). Use a group id, or "__ungrouped__" for creators in no group, in the `groupIds` filter of GET /brands/{brandId}/creators. One group, with the flows and links that place joiners in it, is at GET .../creator-groups/{groupId}.

Remove creators from a creator group DELETE

Remove creators from a group. They stay in the brand and in any other groups. 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.