Skip to main content
POST
Update the current authenticated user

Authorizations

Authorization
string
header
required

Cognito JWT token for regular user authentication

Body

Request body for updating user profile. All fields are optional - include only the fields you want to update.

Request body for updating user profile. All fields are optional - include only the fields you want to update.

timezone
string

User's timezone in IANA format

Example:

"America/New_York"

notificationPreferences
object[]

Notification preferences to update. Supports partial updates: only include the notification types you want to change. For each type included, you can update just 'email', just 'mobile', or both fields. Notification types not included in this array will retain their existing settings.

Example:

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