Users

Update

Updates the authenticated user's settings document. Replaces the top-level keys it is given and leaves the rest untouched.

patch/users/me/preferences

Request body

bounty_worker_onboarding_dismissedboolean

Whether the user has dismissed the first-time bounty worker onboarding. Set to false to show it again.

investigation_enabledboolean

Whether investigation mode is enabled for the user. Only meaningful for staff users with investigation access.

terms_acceptedboolean

Records the user's acceptance of Whop's terms and policies. Only true is accepted — the server stamps terms_accepted_at and acceptance cannot be withdrawn here.

Example request

{
  "bounty_worker_onboarding_dismissed": true,
  "terms_accepted": true
}

Response

preferences updated

bounty_worker_onboarding_dismissedboolean required

Whether the user has dismissed the first-time bounty worker onboarding. Set to false to show it again.

investigation_enabledboolean required

Whether investigation mode is enabled for the user. Only meaningful for staff users with investigation access.

terms_acceptedboolean required

Whether the user has accepted Whop's terms and policies. false until recorded via PATCH with terms_accepted: true.

terms_accepted_atstring nullable required

When the user most recently accepted Whop's terms and policies, as an ISO 8601 timestamp. null until accepted.

Example response

{
  "investigation_enabled": true,
  "terms_accepted": true,
  "terms_accepted_at": "2026-01-01T12:00:00.000Z"
}

Changes

Changed in 5 of the 41 revisions of this API.9

    • added the new optional request property terms_accepted

      new-optional-request-property

    • added the required property terms_accepted to the response with the 200 status

      response-required-property-added

    • added the required property terms_accepted_at to the response with the 200 status

      response-required-property-added

    • added the new optional request property bounty_worker_onboarding_dismissed

      new-optional-request-property

    • added the required property bounty_worker_onboarding_dismissed to the response with the 200 status

      response-required-property-added

    • added the optional property error/code to the response with the 400 status

      response-optional-property-added

    • added the optional property error/code to the response with the 401 status

      response-optional-property-added

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

    • the security scope user:profile:update was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

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

    • endpoint added

      endpoint-added

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