This API helps you to update a guest's password by using the one-time password (OTP) that was sent to the guest's registered email ID after resetting the password.
To invoke this API, you must specify a unique identifier of the guest in the request as guest_id.
You must also provide in the request body the verification_code and verification_id details that the guest received after resetting the password. After the verification_code and verification_id details have been successfully validated, the guest's password is updated to the new_password value.
This API either returns a success parameter that indicates that the password-updation process was successful or returns 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.
- The new_password value must meet Zenoti's password criteria.
Zenoti's Password Criteria
The password must contain a minimum of 8 characters.
The password must not contain the username details.
The password must contain at least 3 of the following 4 categories:
- Uppercase characters (A-Z)
- Lowercase characters (a-z)
- Base digits (0-9)
- Special characters ([~|!|@|#|$|%|^|&|*|+|=|||||(|)|{|}|[|]|;|:|'|"|<|>|,|.|-|_|/|?]/;)`
Request Body Details
| Name | Type | Description |
|---|---|---|
| new_password | string | New password of the guest. |
| 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 that is generated after resetting the password. |
Response Details
| Name | Type | Description |
|---|---|---|
| success | bool | Indicates whether the guest's password has been successfully updated. |
| 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. |