Bloss Docs

Rename or recolour a creator group

Developers
PATCH
/brands/{brandId}/creator-groups/{groupId}

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

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

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 PATCH 'https://example.com/api/v1/brands/string/creator-groups/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "name": "string",  "color": "string",  "sortOrder": 0}

Was this page helpful?

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.

Get the brand's API keys and webhooks GET

Settings › Integrations: the brand's API keys (name, prefix, permissions, status, last use; never the key) and its webhooks (destination host, masked URL, what they notify about). Webhook URLs are secrets, so only the host is returned in full.