Change the name you are shown by

This page as Markdown, or in an AI chatMore ways to read this page

Change the name you are shown by. Signed in only, not with a token.

# Change the name you are shown by

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/patch-me

`PATCH /api/v1/me`

Change the name you are shown by. Signed in only, not with a token.

## What to send

`NameChange`

- `name` (string, needed)

## The answer

200, `Me`

- `account_id` (string, needed)
- `account_name` (string, needed)
- `accounts` (list of MeAccount): Every account they are in. One is the account this answer is about; a person in one account has one here.
- `email` (string, needed)
- `features` (FeatureSet, needed)
- `invite_needed` (boolean): Another account of theirs needs an invite code (doc/invites.md).
- `may` (list of string): What this request may do: `read`, `events`, `manage`, `visitors`, `own`. A page hides what would be refused.
- `name` (string): What they are called. Empty until they say.
- `operator` (boolean): Whoever runs this tidekeeper: the operator's console is theirs.
- `role` (string, needed)
- `second_step_missing` (boolean): The account's owner asked that every member has a second step at sign-in, and this member has not set one up.
- `some_sites` (boolean): Given some of the account's sites, not all.
- `user_id` (string, needed)

## Asking

```sh
curl -X PATCH https://tidekeeper.eu/api/v1/me \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "…"}'
```

What to send

NameChange

name: stringneeded

The answer

Status 200

Me

account_id: stringneeded
account_name: stringneeded
accounts: list of MeAccountEvery account they are in. One is the account this answer is about; a person in one account has one here.
email: stringneeded
features: FeatureSetneeded
invite_needed: booleanAnother account of theirs needs an invite code (doc/invites.md).
may: list of stringWhat this request may do: `read`, `events`, `manage`, `visitors`, `own`. A page hides what would be refused.
name: stringWhat they are called. Empty until they say.
operator: booleanWhoever runs this tidekeeper: the operator's console is theirs.
role: stringneeded
second_step_missing: booleanThe account's owner asked that every member has a second step at sign-in, and this member has not set one up.
some_sites: booleanGiven some of the account's sites, not all.
user_id: stringneeded

Asking

curlJavaScript

With your token from Settings

curl -X PATCH https://tidekeeper.eu/api/v1/me \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "…"}'

With your token from Settings

const answer = await fetch("https://tidekeeper.eu/api/v1/me", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"name": "…"}),
}).then((r) => r.json());