Users

Update

Changed on

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

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/users/me/preferences
  • Auth: HTTP bearer

Request body

bounty_worker_onboarding_dismissedboolean

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

cards_auto_top_upboolean

Whether incoming funds, including pending balance, are automatically moved to the user's personal cards balance. Requires a cards balance and the payout:account:update permission.

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.

cards_auto_top_upboolean required

Whether incoming funds, including pending balance, are automatically moved to the user's personal cards balance. false when the user has no cards balance.

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

  • 7d2eaa643369Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

  • 6a23760847c8Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status