Skip to content
Connect an agent

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/verify

TL;DR

QuestionAnswer
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.

FieldTypeRequiredDescription
emailstringyesat least 3 characters; at most 254 characters.
codestringyespattern ^\d{6}$.

Responses

StatusMeaningBody
200The account now.AccountProfile
400The body is not valid.ErrorResponse
401Not signed in, or the code is wrong, expired, or used (auth.code_invalid).ErrorResponse
403An organisation manages the address (account.email_managed), or the origin may not make changes.ErrorResponse
409Another account has the address (account.email_taken).ErrorResponse
429Too many requests.ErrorResponse

Response body

A 200 answer has the type AccountProfile.

FieldTypeRequiredDescription
idstringyes
emailstringyes
namestring | nullyesThe name the account is shown by, or null for none.
createdAtintegeryesWhen the account was made, in milliseconds since the epoch.

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools