RMail API

Back to Account (v1)

POST api/V1/Account/ForgotPassword

Returns whether an email has been sent or not regarding forgot password.

Prerequisites

To be implemented

Request Information

Lorem ipsum

URI Parameters

none

Header Parameters

Header Description

Name Description Type
Content-Type This is a request content type application/json
Accept This is a response content type application/json
AuthToken This is user’s authorization token. example@example.com^296f1f85-35d4-4dd4-a350-67131c926546^rps^en-US

Note: From the Header parameters mentioned, “AuthToken” is not required for the below mentioned services.

  • Account/RegisterUser
  • Authentication/AuthenticateUser

Body Parameters

UserEmailAddress

Name Description Type Additional information
UserEmailAddress Email address for which password has to reset. stringNone.

Request Formats

application/json, text/json
Sample:
{
"UserEmailAddress": "sample string 1"
}
application/xml, text/xml
Sample:
<ForgotPasswordModal xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<UserEmailAddress>sample string 1</UserEmailAddress>
</ForgotPasswordModal>

Response Information

Resource Description

true/false

Name Description Type Additional information
StatusCode This will return Status Code. HttpStatusCode None.
StatusMessage This will return Status Message. string None
Message This will return response message for corresponding status code. string None
data Object None

Response Formats

application/json, text/json
Sample:
{
"StatusCode": 100,
"StatusMessage": "sample string 1",
"Message": "sample string 2",
"data": {}
}
application/xml, text/xml
Sample:
<ResponseMessage xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<StatusCode>Continue</StatusCode>
<StatusMessage>sample string 1</StatusMessage>
<Message>sample string 2</Message>
<data ></data>
</ResponseMessage>

Was this page helpful?