Update current user

PATCH

Updates the currently authenticated user. Only the values provided will be updated.

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 can be used to sign into this user’s account

passwordstringOptional

A new password for the user, overwriting the old one (if it exists). Specifying this option revokes all current sessions.

totp_secret_base64stringOptional

A TOTP secret for the user, overwriting the old one (if it exists). Set to null to disable 2FA.

selected_team_idstringOptional

ID of the team currently selected by the user

Response

This endpoint returns an object.
idstring

The unique identifier of this user

primary_email_verifiedboolean

Whether the primary email has been verified to belong to this user

signed_up_at_millisdouble

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

has_passwordboolean

Whether the user has a password associated with their account

last_active_at_millisdouble

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

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.

Built with