Server APIUsers

Update user

Updates a user. Only the values provided will be updated.

Path parameters

user_idstringRequired

The ID of the user, or the special value me for the currently authenticated user

Request

This endpoint expects an object.
display_namestringOptional

Human-readable user display name. This is not a unique identifier.

profile_image_urlstringOptional
URL of the profile image for user. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.
client_metadatamap from strings to anyOptional
Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.
client_read_only_metadatamap from strings to anyOptional

Client read-only, server-writable metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client. The client can read this data, but cannot modify it. This is useful for things like subscription status.

server_metadatamap from strings to anyOptional
Server metadata. Used as a data store, only accessible from the server side. You can store secret information related to the user here.
primary_emailstringOptional
Primary email
primary_email_verifiedbooleanOptional
Whether the primary email has been verified to belong to this user
primary_email_auth_enabledbooleanOptional

Whether the primary email is used for authentication. If this is set to false, the user will not be able to sign in with the primary email with password or OTP

passwordstringOptional
Sets the user's password. Doing so revokes all current sessions.
password_hashstringOptional

If password is not given, sets the user’s password hash to the given string in Modular Crypt Format (ex.: $2a$10$VIhIOofSMqGdGlL4wzE//e.77dAQGqNtF/1dT7bqCrVtQuInWy2qi). Doing so revokes all current sessions.

totp_secret_base64stringOptional
Enables 2FA and sets a TOTP secret for the user. Set to null to disable 2FA.
selected_team_idstringOptional
ID of the team currently selected by the user
is_anonymousbooleanOptional

Response

Successful response
idstring
The unique identifier of the user
primary_email_verifiedboolean
Whether the primary email has been verified to belong to this user
primary_email_auth_enabledboolean

Whether the primary email is used for authentication. If this is set to false, the user will not be able to sign in with the primary email with password or OTP

signed_up_at_millisdouble

The time the user signed up (identify) => (the number of milliseconds since epoch, January 1, 1970, UTC)

last_active_at_millisdouble

The time the user was last active (identify) => (the number of milliseconds since epoch, January 1, 1970, UTC)

is_anonymousboolean
primary_emailstringOptional
Primary email
display_namestringOptional

Human-readable user display name. This is not a unique identifier.

selected_teamobjectOptional
selected_team_idstringOptional
ID of the team currently selected by the user
profile_image_urlstringOptional
URL of the profile image for user. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.
client_metadatamap from strings to anyOptional
Client metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client.
client_read_only_metadatamap from strings to anyOptional

Client read-only, server-writable metadata. Used as a data store, accessible from the client side. Do not store information that should not be exposed to the client. The client can read this data, but cannot modify it. This is useful for things like subscription status.

server_metadatamap from strings to anyOptional
Server metadata. Used as a data store, only accessible from the server side. You can store secret information related to the user here.