ForgotPassword
From ePrize Developers Wiki
(Difference between revisions)
(New page: ==Summary== Initiates forgot password flow to send the password change email. '''Resource''' POST api/v1/forgotPassword '''Parameters''' emailAddress '''Example Call''' http://demo-l...) |
(→Summary) |
||
| Line 10: | Line 10: | ||
'''Parameters''' | '''Parameters''' | ||
| - | emailAddress | + | * emailAddress |
| - | + | ||
| - | + | ||
| - | + | ||
Example Request Body: | Example Request Body: | ||
| - | { | + | { |
| - | + | "email": "jon.doe@helloworld.com" | |
| - | } | + | } |
Example Response: Success | Example Response: Success | ||
| - | { | + | { |
| - | + | "success": true | |
| - | } | + | } |
Example Response: Email Address not provided | Example Response: Email Address not provided | ||
| - | { | + | { |
| - | + | "Error": { | |
| - | + | "Code": "error.business.Validation", | |
| - | + | "Message": "Error for attribute: Email Address\nThis information is required.\n" | |
| + | } | ||
} | } | ||
| - | } | ||
Current revision
Summary
Initiates forgot password flow to send the password change email.
Resource
POST api/v1/forgotPassword
Parameters
- emailAddress
Example Request Body:
{
"email": "jon.doe@helloworld.com"
}
Example Response: Success
{
"success": true
}
Example Response: Email Address not provided
{
"Error": {
"Code": "error.business.Validation",
"Message": "Error for attribute: Email Address\nThis information is required.\n"
}
}
