Skip to content
SupaCloud Docs
Select themeSelect language

PUT /api/me — update the user profile and return the refreshed profile.

PUT
/api/me
curl --request PUT \
  --url https://example.com/api/me \
  --header 'Content-Type: application/json' \
  --data '{ "avatar_color": "example", "avatar_image_data": "example", "display_name": "example", "locale": "example", "ui_preferences": { "font_size": "small", "tour_seen": true } }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

The PUT /api/me body — a PATCH: an OMITTED field is left alone, a field sent as null is cleared.

The three text fields are Option<Option<String>> so that distinction survives deserialization. It is load-bearing: every one of them used to be overwritten with NULL by any request that did not carry it, so changing your language (web sidebar, web CLI language, or /language de in Telegram/Discord — all locale-only requests) silently WIPED your display name and avatar. #[schema(value_type = Option<String>)] pins the rendered OpenAPI to exactly what it was, so the wire contract is unchanged; only the server’s reading of an ABSENT field is fixed.

object
avatar_color
string | null
avatar_image_data
string | null
display_name
string | null
locale
string | null
ui_preferences
One of:
null

Responses

Section titled “Responses”

200

Section titled “200”

The updated user profile

Media typeapplication/json

The current user’s profile + session-bootstrap flags — the body of both GET /api/me and PUT /api/me. Faithful to the JSON [me_response] builds.

object
active_org_role
required
One of:
null
active_workspace_role
required
One of:
null
approved
required
boolean
avatar_color
required
string | null
avatar_image_data
required
string | null
created_at
required
string format: date-time
default_verbosity
required

The user’s stored default live-feed verbosity (#583 / ADR 0049): the raw persisted label "reduced" | "chatty", or null when no default is set (the feed then falls back to the built-in reduced). The web CLI’s density command reads this to show / change the current setting.

string | null
display_name
required
string | null
email
required

The authenticated email; null for an identity without a stored email.

string | null
email_verified
required
boolean
id
required
string format: uuid
is_admin
required
boolean
locale
required
string
mfa_enabled
required
boolean
telegram_linked
required
boolean
ui_preferences
required

The account’s ROAMING UI preferences (#838, migration 355) — a sparse bag, so a key is present only once the user has actually chosen it. An absent key means “never chosen”: the client keeps its browser-local value (and still shows the first-run tour). Theme is deliberately NOT here — dark/light stays per-device.

object
font_size
One of:
null
tour_seen

true once the user has completed or dismissed the first-run tour on ANY device. Absent means “never seen it” — so a brand-new account still gets the tour, while a second device for an existing account does not replay it.

boolean | null
Example
{
  "active_org_role": "owner",
  "active_workspace_role": "owner",
  "ui_preferences": {
    "font_size": "small"
  }
}

400

Section titled “400”

Structured client error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}