Skip to content

Update display name

PUT
/v1/me

Change the editable parts of the signed-in user's profile — right now, just the display name. Email and the member-since date are read-only and can't be changed here.

Authorizations

Bearer

JWT bearer token from POST /v1/auth/login.

Type
HTTP (bearer)
or
ApiKey

Scoped API key for non-interactive clients (issued by PBI #1426).

Type
API Key (header: X-Api-Key)

Request Body

application/json

Profile update payload (PUT /me) — the editable display name.

The new display name to show in the UI.

Responses

OK

application/json

The signed-in user's profile, preferences, and avatar state — the shared success body for
GET /me, PUT /me, and PUT /me/preferences.

When the avatar was last changed, or null when no
avatar is set.

Format"date-time"

When the account was created, or null if the account
record could not be loaded (a valid token whose account row is gone).

Format"date-time"

The account's editable display name.

The account's email address.

Whether the account's email address has been verified.

Whether the account has an uploaded avatar image.

Whether the account has a password set (false for an
OAuth-only account that signs in only with Google/Apple). Lets the Account Security UI (#2127) hide the
change-password / change-email forms an OAuth-only user can't use, rather than surfacing a
password_not_set error after they submit.

Stable identifier for this account.

Format"uuid"

The account's display name, kept alongside string? MeView.DisplayName for
backward compatibility with older callers.

The account's saved application preferences.

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI