Keys
Ask to move your account to another email address
Emails a six-digit code to the new address.
POST
/user/email/changeTL;DR
| Question | Answer |
|---|---|
| What does it do? | Ask to move your account to another email address. |
| What does it take? | A JSON body of type EmailChangeBody. |
| What does it return? | Status 202 with a body of type Accepted. |
| What can go wrong? | 400 the address is not valid; 401 not signed in; 403 an organisation manages the address (account.email_managed), or the origin may not make changes; 409 it is already the account's address (account.email_same); 429 too many requests; 502 the email could not be sent. Every failure uses the one error envelope. |
What it does
Emails a six-digit code to the new address. Nothing changes until it is entered with POST /user/email/verify.
Request body
The body has the type EmailChangeBody.
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | at least 3 characters; at most 254 characters. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 202 | Accepted. | Accepted |
| 400 | The address is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | An organisation manages the address (account.email_managed), or the origin may not make changes. | ErrorResponse |
| 409 | It is already the account's address (account.email_same). | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 502 | The email could not be sent. | ErrorResponse |
Response body
A 202 answer has the type Accepted.
| Field | Type | Required | Description |
|---|---|---|---|
accepted | true | yes |
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 |