Skip to main content
POST
Start an email update

Authorizations

Authorization
string
header
required

Cognito JWT token for regular user authentication

Body

Starts a pending email update by sending a one-time code to the requested email address.

Starts a pending email update by sending a one-time code to the requested email address.

email
string<email>
required

The email address to add to the current account or replace the existing one.

Example:

"user@example.com"

Response

Pending email update session details. Confirm the session with the code sent to the new email address.

Pending email update session details. Confirm the session with the code sent to the new email address.

sessionId
string
required

Opaque identifier for the pending email update confirmation session.

Example:

"8ebd7043-c4d7-4136-9db1-8ced22a91f78"

deliveryMethod
enum<string>
required

How the one-time confirmation code is delivered.

Available options:
email