Skip to main content
PATCH
Update the current user

Authorizations

Authorization
string
header
required

Gumnut API key (apikey_...) sent as a Bearer token in the Authorization header. Create and manage keys in the Gumnut app, or with the API key endpoints while signed in to it.

Body

application/json

Updatable fields on the authenticated user's own account.

favorite_display_mode
enum<string> | null

Preferred favorite/rating display mode. Omit to leave unchanged; send null to reset to the default (favorite mode).

Available options:
favorite,
rating

Response

Successful Response

Represents a user account with profile information.

id
string
required

Unique user identifier with 'intuser_' prefix

favorite_display_mode
enum<string>
required

The user's effective favorite/rating display mode, defaulting to favorite when they have never selected one.

Available options:
favorite,
rating
is_active
boolean
required

Whether this user account is currently active

is_superuser
boolean
required

Whether this user has superuser/admin privileges

is_verified
boolean
required

Whether the account is marked verified. An internal account flag, not proof of email verification — it can be true even when email is null

storage_used_bytes
integer
required

Total bytes of assets the user is currently storing

storage_limit_bytes
integer
required

Maximum bytes of assets the user may store

created_at
string<date-time>
required

When this user account was created

updated_at
string<date-time>
required

When this user account was last updated

email
string | null

User's email address

first_name
string | null

User's first name

last_name
string | null

User's last name

timezone
string | null

User's home timezone as an IANA zone id (e.g. 'America/Los_Angeles'); null until a home zone is captured