Keys
Move your account to the new email address
Checks the code sent to the new address and moves the account to it.
POST
/user/email/verifyTL;DR
| Question | Answer |
|---|---|
| What does it do? | Move your account to the new email address. |
| What does it take? | A JSON body of type EmailVerifyBody. |
| What does it return? | Status 200 with a body of type AccountProfile. |
| What can go wrong? | 400 the body is not valid; 401 not signed in, or the code is wrong, expired, or used (auth.code_invalid); 403 an organisation manages the address (account.email_managed), or the origin may not make changes; 409 another account has the address (account.email_taken); 429 too many requests. Every failure uses the one error envelope. |
What it does
Checks the code sent to the new address and moves the account to it. The old address gets a notice. Sessions stay open.
Request body
The body has the type EmailVerifyBody.
| Field | Type | Required | Description |
|---|---|---|---|
email | string | yes | at least 3 characters; at most 254 characters. |
code | string | yes | pattern ^\d{6}$. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The account now. | AccountProfile |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in, or the code is wrong, expired, or used (auth.code_invalid). | ErrorResponse |
| 403 | An organisation manages the address (account.email_managed), or the origin may not make changes. | ErrorResponse |
| 409 | Another account has the address (account.email_taken). | 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 |