Bloss Docs

Set a creator group's trial

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

Set the trial a group gives its members, as a whole: "default" (the brand's default trial), "off" (no trial: members on Trial move to Active straight away) or "custom" with days (1–365), viewGoal (views each video must reach, 0–1,000,000,000) and videoGoal (how many such videos pass, 1–100). Terms are live: members already on Trial move to the new terms straight away, and any the new terms pass move to Active at once, which can pay a referral bonus. That's why this needs payouts:write as a full admin. With ?dryRun=true nothing is written; the answer has trialChanges (see brand.groups.members.add).

Authorization

bearerAuth payouts: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: payouts: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
trial*||

Response Body

Success.

application/json
  1. response
changed*boolean

False when the group already had this trial.

updatedAt*string
curl -X PATCH 'https://example.com/api/v1/brands/string/creator-groups/string/trial' \  -H 'Content-Type: application/json' \  -d '{  "trial": {    "mode": "default"  }}'
{  "changed": true,  "updatedAt": "string"}

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.

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 and no trial; set them with brand.group.pay.update and brand.group.trial.update.