Skip to main content
PATCH
Update user password

Authorizations

Authorization
string
header
required

An access token used to authenticate a user and grant access to restricted APIs. It is issued by session APIs. For status codes related to this header, refer to the Common Headers Documentation.

Body

application/json

The request body for updating user password

newPassword
string
required

The new password.

Example:

"MyNewSecurePassword123!"

currentPassword
string

The user's current password for update password.

  • This field is only required for authenticated users.
Example:

"OldPassword123!"

passwordResetToken
string

A temporary Bearer token used for password reset authentication which is issued when a user requests a password reset.

  • This field is only required for password reset users.
Example:

"eyJhbGciOiJIUzI1NiIsInR..."

otpCode
string

A one-time passcode (OTP) for reset user password.

  • Must be a numeric code.
  • This field is only required for password reset users.
Example:

321673

Response

Successfully updated user password.