The Voomerr Set Forget Password allows users to reset their password using their email address. This accepts an email address and sends a password reset link to the specified email address.
Endpoint #
The Voomerr Set Forget Password API endpoint is POST https://admin.voomerr.com/api/forgot_password.php.
Request Parameters #
The following parameter is required to initiate the password reset process:
| Parameter | Type | Required | Description |
|---|---|---|---|
| string | Yes | The email address associated with the user account for which the password needs to be reset. |
Example Request #
POST https://admin.voomerr.com/api/forgot_password.php
{
"email": "john.doe@example.com"
}
Response #
The response from the API will contain a JSON object with the following fields:
| Field | Type | Description |
|---|---|---|
| success | boolean | Whether the request was successful or not. |
| message | string | A message describing the result of the request. |
If the request is successful, the ‘success’ field will be ‘true’, and the ‘message’ field will contain a success message indicating that the password reset link has been sent to the email address. If the request fails, the ‘success’ field will be ‘false’, and the ‘message’ field will contain an error message indicating that the password reset process has failed.
Example Response #
{
"success": true,
"message": "Password reset link has been sent to your email address."
}
