Keys
Change the name your account is shown by
Sets the display name, trimmed, at most 80 characters with no line breaks.
PATCH
/user/profileTL;DR
| Question | Answer |
|---|---|
| What does it do? | Change the name your account is shown by. |
| What does it take? | A JSON body of type UpdateProfileBody. |
| What does it return? | Status 200 with a body of type AccountProfile. |
| What can go wrong? | 400 the name is too long or has a line break; 401 not signed in; 403 the request came from an origin that may not make changes; 429 too many requests. Every failure uses the one error envelope. |
What it does
Sets the display name, trimmed, at most 80 characters with no line breaks. An empty name or null clears it.
Request body
The body has the type UpdateProfileBody.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | null | yes | The name to be shown by, at most 80 characters once trimmed, with no line breaks. Empty or null clears it. at most 320 characters. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The account now. | AccountProfile |
| 400 | The name is too long or has a line break. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | The request came from an origin that may not make changes. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
Response body
A 200 answer has the type AccountProfile.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
email | string | yes | |
name | string | null | yes | The name the account is shown by, or null for none. |
createdAt | integer | yes | When the account was made, in milliseconds since the epoch. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |