API will call to forgot password and send email with reset password link.
Resource URL
https://Server Node Environment/index.php
Example : https://api.yourdomain.com/index.php
Resource Information
| Parameters |
Values |
| Resource Format |
JSON |
| Method |
POST |
| Requires authentication? |
Yes |
Request
GET Params
| Parameters |
Mandatory |
Description |
| [Request parameters] |
|
|
| d |
REQUIRED |
api - Controller directory name |
| c |
REQUIRED |
users - Controller name |
| m |
REQUIRED |
forgot_pass - Controller method name |
| token |
REQUIRED |
Application Access Token |
POST Params
| Parameters |
Mandatory |
Description |
| [Request parameters] |
|
|
| email |
REQUIRED |
Agent Email Address |
Response
{
"result": "success",
"language_version": 20171221061942,
"message": "Reset Password Link has been sent to your email.check your email."
}
Messages returned
| HTTP STATUS CODE |
Description |
MESSAGE BODY |
| 200 |
Successfully Return |
Return Json data. |
| 200 |
Authorization Error |
{"result":"failed","error":"Invalid access token or Token has been expired."} |
| 400 |
Request is malformed |
{"error": "invalid_request", "error_description": "description"} |
| 403 |
Forbidden |
Directory access is forbidden. |
| 404 |
Resource Not found |
The page you requested was not found. |