Skip to content
LogoLogo

Update the current user's profile

Update the current user's profile

PATCH/api/v1/me

Updates one or more editable current-account profile and interface preference fields. Email remains read-only here: changing it is a separate verification flow that must prove control of the new mailbox.

The update is compare-and-swap. If-Match carries the user revision last observed by the client, and a stale value is refused with 409 rather than silently overwriting a concurrent edit.

Header Parameters

X-CSRF-Token
string·min 1·max 200

Required when this operation uses browserSession; native bearer callers omit it because no ambient cookie is sent.

If-MatchRequired
string

Entity tag containing the resource version last observed by the client.

Request Body

application/json
display_name
string·min 1·max 100

The user's full display name, trimmed before validation.

username
string·min 3·max 30

Lowercased after trimming and unique across accounts. Only letters, numbers, and interior dots are accepted.

profile_picture_url
string·max 2048

An HTTPS image URL. An empty string removes the picture.

avatar_initials
string·max 2

Avatar letters override, 1–2 characters stored uppercased. An empty string clears the override and returns to name-derived letters.

avatar_color
string·max 11

Shared user-chosen color: a Tailwind color family name, optionally pinned to one Tailwind step (for example amber or amber-400). A bare name lets each client choose the shade for its surface; a pinned step renders that exact shade.

Exampleindigo
title
string·max 100

Optional job title or role. An empty string removes it.

phone
string·max 16

Optional E.164 profile-only phone number; empty removes it. It is not an authentication or notification destination.

bio
string·max 500
status
string·max 100
name_display
string

Which account name is preferred on compact identity surfaces. Username requires a selected username.

Values
usernamefull_name
first_day_of_week
string
Values
sundaymonday
first_day_of_week_inherited
boolean

Set true to use the current Workspace default; set false to keep a concrete Account value.

timezone
string·min 1·max 64

Optional IANA timezone used for calendar-bound personal Work views. Invalid names are rejected; the server never guesses a timezone.

timezone_inherited
boolean

Set true to use the current Workspace default; set false to keep a concrete Account value.

interface_language
string

Account interface language. Automatic follows qualified device preferences with English fallback. Only qualified public languages are writable; sample catalogs are not admitted. Values are trimmed and case-normalized.

Values
automaticen
locale
string·max 35
locale_inherited
boolean

Set true to use the current Workspace default; set false to keep a concrete Account value.

date_format
string
Values
localemdydmyymd
time_format
string
Values
locale12h24h
number_format
string
Values
localedecimal_commadecimal_point
voice_language
string·max 35
voice_spoken_responses
string
Values
offconfirmationsfull
voice_confirmation
string
Values
standardconfirm_more
voice_show_transcript
boolean
editor_controls
string

Selects contextual or persistent formatting controls across Document, Task-description, and Comment editors.

Values
contextualpersistent

Responses

Authentication · Conventions and errors · API guides · Resource reference