Bloss Docs

Create a creator group

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

Create an empty creator group at the end of the brand's group order. A brand can have up to 25 groups. A name already in use answers 409 conflict. Add creators with brand.groups.members.add. A new group sets no pay; set it with brand.group.pay.update.

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

Request Body

application/json
  1. body
name*string

The group's name, 1–40 characters. Unique in the brand, ignoring case.

Length1 <= length <= 40
color?|

A colour token for the group's chip, or null for neutral.

Response Body

Success.

application/json
  1. response
id*string
name*string
color*|

A colour token name, or null.

sortOrder*number

Position in the brand's group order; lower comes first.

curl -X POST 'https://example.com/api/v1/brands/string/creator-groups' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
{  "id": "string",  "name": "string",  "color": "string",  "sortOrder": 0}

Was this page helpful?

Change a creator group's pay PATCH

Change what a creator group pays its members: base pay per set, the bonus, the minimum-views threshold, or the note. Moves money: every member whose pay changes has their unpaid cycles repriced right away (paid cycles never change), and `repriced` says how many. Send only what changes: an omitted field keeps its value, null makes the group stop setting it so members inherit the brand's rule. The bonus is replaced as a whole. A creator's own deal still wins over the group's, and a higher group in the brand's order wins over a lower one. Refused with 409 conflict while a payment is being sent to a member. Full admins only. A preview's `changes` says which of base pay, bonus, minimum views and note would change; a note alone reprices nobody. 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.

Delete a creator group DELETE

Delete a group. Its creators aren't removed from the brand: they just leave this group (and stay in any others), and invite links that added people to it stop adding them to a group. 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. Returns how many active creators were in it.