Creators

Update Creator

put/v1/creators/{creator_id}

Path parameters

creator_idstring required

Request body

namestring
emailstring
avatar_urlstring uri
extra_terms_urlstring uri
extra_terms_textstring
creator_tier_group_idstring

New tier group to assign the creator to.

revenue_share_override_enabledboolean

When true, the creator's revenue share is fixed at revenue_share_override_bps and ignores tier rates.

revenue_share_override_bpsinteger

Override revenue share in basis points; required when enabling the override.

payout_fee_creator_share_bpsinteger

Share of the payment provider's fee this creator carries, in basis points. Pass null to fall back to the project-wide setting; omit to leave it untouched.

Response

Successful Response

namestring required
emailstring required
avatar_urlstring
extra_terms_urlstring
extra_terms_textstring
idstring required
coupon_countinteger
revenueinteger
balanceinteger
creator_tier_group_idstring

Identifier of the tier group the creator is assigned to, if any.

current_creator_tier_idstring

Identifier of the tier the creator currently qualifies for based on lifetime gross revenue.

revenue_share_override_enabledboolean

When true, revenue_share_override_bps takes precedence over the tier's revenue_share_bps.

revenue_share_override_bpsinteger

Per-creator revenue share override in basis points (0-10000).

lifetime_gross_usd_centsinteger

Cumulative gross revenue attributed to the creator, in USD cents.

payout_fee_creator_share_bpsinteger

Share of the payment provider's fee this creator carries, in basis points. Takes precedence over the project-wide setting; null falls back to it.

Changes

Changed in 5 of the 28 revisions of this API.27

    • ●

      for the path request parameter creator_id, the maxLength was set to 32

      request-parameter-max-length-set

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ef61f771db1d12See the full diff
    • ●

      the request property's maxLength was set to 32

      request-property-max-length-set

    • ○

      the request property default value other was added

      request-property-default-value-added

    • ○

      the response's property default value other was added for the status

      response-property-default-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property to the response with the status

      response-optional-property-added