Change Password

Lets you modify the current password of a customer. This is applicable only for brands for which password is enabled.

Resource Information

URI for Mobile App/auth/v1/password/change
URI for Web App/auth/v1/web/password/change
Rate Limited?Yes
AuthenticationToken-based
HTTP MethodPOST
Batch SupportNo

Request URL

For mobile application:

http://{ae-host}/auth/v1/password/change

For web application:

http://{ae-host}/auth/v1/web/password/change

Request Body Parameters

ParameterDatatypeDescription
identifierType*enumIdentifier used for changing the password. Values: MOBILE, EMAIL, USERNAME.
identifierValue*stringValue of the specified identifierType. For example, if identifierType is MOBILE, the identifierValue is the mobile number.
deviceId**stringUnique ID of the device used for changing the password. Applicable only for the mobile app.
brandstringName of the brand or organization associated with the current account.
tokenstringUnique token generated for the identifierType and identifierValue. For the web application, it also includes deviceId for the mobile app.
passwordstringExisting password of the account.
newPasswordstringNew password the customer would like to have.
confirmPasswordstringReenter the new password for confirmation.

Parameters marked with * are mandatory.

Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!