Skip to main content
POST
Confirm an email update

Authorizations

Authorization
string
header
required

Cognito JWT token for regular user authentication

Path Parameters

sessionId
string
required

Identifier returned when the email update session was created.

Minimum string length: 1

Body

Confirms a pending email update session and applies the new email address to the current account.

Confirms a pending email update session and applies the new email address to the current account.

code
string
required

Six-digit confirmation code sent to the new email address.

Required string length: 6
Pattern: ^[0-9]{6}$
Example:

"123456"

Response

Response for status 200

id
string
required

Unique identifier for the user

Example:

"6a749a054c3b8fc5da595d1a"

email
string<email> | null
required

User's email address

Example:

"user@example.com"

firstName
string | null
required

User's first name

Example:

"John"

signedUpAt
string<date-time>
required

ISO 8601 timestamp of when the user was created

Example:

"2026-08-06T14:28:21.827Z"

timezone
string | null
required

User's timezone in IANA format

Example:

"America/New_York"

notificationPreferences
object[]
required

User's notification preferences by type

verification
object
required

User's identity verification status and any pending requirements

capabilities
object[]
required

User's available capabilities and their requirements