post https://api.zenoti.com/v1/guests/password?reset=true
This API helps you to reset a guest's password.
When you invoke this API, a temporary code is generated that does not actually replace a guest's existing password. The temporary code acts as a one-time password (OTP), by using which guests can validate their update password request.
This API also takes care of scenarios where there might be multiple accounts found with the same username. In that case, the guest's first_name is provided so that the appropriate account can be identified and the reset password email can then be sent to that user.
This API returns either a success parameter that specifies that the password-reset process was successful or an error object if there is any error.
Notes :
- You cannot invoke this API by using the tokens that are generated from the guest credentials.
- Only those employees who have a role that has permissions to edit a guest’s information, are allowed to access this API.
- A password reset email or text message is not sent if Zenoti is unable to identify a unique guest with the provided email, phone, or first_name details.
Response Details
| Name | Type | Description |
|---|---|---|
| success | bool | Indicates whether the password-reset process was successful. |
| user_id | guid | Unique 32-character identifier of the guest. |
| user_count | int | Indicates the number of users identified with the provided email, phone, and first_name details. |
| matched_with | enum | Indicates to which details of the guest did the request match: 0 - no match, 1 - username, 2 - email, and 3 - mobile. |
| verification_code | string | The temporary code or one-time password (OTP) that is sent to the guest's registered email ID after resetting the password. |
| verification_id | guid | Unique 32-character verification identifier of the guest. |
| error | object | Object that contains error message and error code details. For more information, refer to the error Object table. |
error Object
| code | message |
|---|---|
| 400 | Bad Request. |
| 401 | Unauthorized. |
| 500 | Internal Server error. |
| 404 | User Not Found. |