Skip to content
Plune Plune Docs

Set your display name, language and theme

PATCH
/v1/me
 
curl --request PATCH \
  --url https://beta-api.plune.ai/v1/me \
  --header 'Content-Type: application/json' \
  --cookie plune_session=<plune_session> \
  --data '{ "name": "Olena Kovalenko" }'

The Account page, «Your name» (api.ts → setMyName). The name is what every screen shows where a row names you — a case you wrote, a run you launched, a result you marked, the Members list — in place of your address; null clears it. The language (en, uk) and the theme (dark, light) of the dashboard are kept here too (#1016, api.ts → setMyPreferences), so another browser opens the way this one does: the dashboard reads them from GET /v1/me when you sign in, and sends one only when you chose it — null is «never chose», and the browser’s own preference stands in. Any of the three, and at least one; what the body does not name is left as it was. Session-only, as the tokens are: a leaked CLI token must not be able to rename you.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json

What a person may say about themselves: any of name, locale and theme, and at least one. What the body does not name is left as it was; null takes a value back.

object
>= 1 properties
name

Trimmed; 1 to 100 characters, or null — the address stands in again.

string
nullable >= 1 characters <= 100 characters
locale

The dashboard’s language, or null for «never chose» — the browser’s own preference stands in again.

string
nullable
Allowed values: en uk
theme

The dashboard’s theme, or null for «never chose».

string
nullable
Allowed values: dark light
Examples

The display name

{
  "name": "Olena Kovalenko"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The signed-in user, as it is now

Media type application/json
object
userId
required
string format: uuid
email
required
string format: email
name
required

The display name (B8-team T3) — what every screen shows where a row names this person, in place of the address. null until given on the Account page.

string
nullable <= 100 characters
locale
required

The language the person chose for the dashboard (#1016), kept with the account so another browser opens in it. null until they choose one: the browser’s own preference stands in, and nothing is written on its behalf.

string
nullable
Allowed values: en uk
theme
required

The theme the person chose for the dashboard (#1016), kept with the account like locale. null until they choose one.

string
nullable
Allowed values: dark light
role
required

What this account is allowed to be, e.g. user or owner. Open-ended: new roles appear without a client release.

string
Example 
{
  "userId": "u-shop",
  "email": "[email protected]",
  "role": "user",
  "name": "Olena Kovalenko",
  "locale": "uk",
  "theme": "light"
}

400

Section titled “400 ”

Not JSON, an empty body, a name that is empty or over 100 characters, or a language or a theme the dashboard does not offer

Media type application/json
object
error
required
string
Example 
{
  "error": "validation failed — name: a name cannot be empty — send null to clear it"
}

401

Section titled “401 ”

No / invalid session

404

Section titled “404 ”

Session valid but the user no longer exists

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

429

Section titled “429 ”

Rate-limited: either the per-route throttle or a tenant quota. Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
  "error": "example"
}

Headers

Section titled “Headers ”
Retry-After
integer

Seconds until the window rolls over