Skip to main content

Update the authenticated user's profile

PATCH 
/api/v1/auth/me

Updates the display name and, optionally, the sign-in email.

Changing email requires currentPassword. The address is trimmed and lowercased, the account's email verification is cleared, every other session of the user is signed out (the caller's own session is kept), and a notice is sent to the previous address when email sending is configured. Sending the current address (in any case) is a no-op. Refusals: 400 VALIDATION_ERROR for a malformed address, 403 INVALID_CURRENT_PASSWORD for a missing or wrong password, 403 FORBIDDEN for an account without a password (change the email at the identity provider), 403 DEMO_READ_ONLY for the shared demo account, 403 IMPERSONATION_FORBIDDEN for an impersonation token, and 409 CONFLICT when another account already uses the address. Records auth.email_changed in each of the user's organizations.

preferences sets the language and timezone the server writes this user's emails in. Every field is optional (a preferences-only body is valid); an empty string clears one. 400 VALIDATION_ERROR for a locale outside en, fr, de, es (a full tag such as fr-FR is accepted and stored as fr) or a timezone the IANA database does not know. Nothing is written when any field is refused.

Request​

Responses​

Updated user information