Bloss Docs

Delete a creator group

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

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.

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"

Response Body

Success.

application/json
  1. response
id*string
name*string
ungroupedCount*number

Active creators who were in the group.

curl -X DELETE 'https://example.com/api/v1/brands/string/creator-groups/string'
{  "id": "string",  "name": "string",  "ungroupedCount": 0}

Was this page helpful?

Create a creator group POST

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.

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}.