Change Password
This API allows users to change their password. It is useful in cases where the password has expired or the user chooses to update their password. This API cannot be used to change the password if the user has forgotten the current one.
🔑Header Parameters
| Header | Type | Description | Example |
|---|---|---|---|
| Content-Type | string | Specifies the format of the request body. | application/json |
| x-api-key | string | The API key provided by SynapseWave for authentication. | x-api-key |
📦Request Body Schema
| Field | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| user_id | string | Yes | Unique Client code (UCC) assigned to the user. | User123456 |
| old_password | string | Yes | The current password of the user. | oldPassword123! |
| new_password | string | Yes | The new password that the user wants to set | newPassword456! |
| api_key | string | Yes | The API key provided by SynapseWave for authentication. | api-key |
| source | string | Yes | Specifies the application from which the user has logged in: WEBAPI (browser-based) or MOBILEAPI (mobile application). | WEBAPI, MOBILEAPI |
🟢Success Response - 200 OK
If the password change is successful the response will contain the following:
🧾Response Body Schema
| Field | Type | Description | Example |
|---|---|---|---|
| status | string | Status of the API Call, typically "success" | "success" |
| code | string | Response code indicating the result of the request | "s-101" |
| message | string | A message confirming the password change. | "Password changed successfully." |
put
/authentication/v1/user/password