POST api/ForgotPassword

Resets user password by email

Request Information

URI Parameters

None.

Body Parameters

The forgot password model containing the email.

ResetPasswordModel
NameDescriptionTypeAdditional information
Email

string

Required

IpAddress

string

None.

ClientId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "email": "sample string 1",
  "ipAddress": "sample string 2",
  "clientId": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseModelOfResetPasswordModel
NameDescriptionTypeAdditional information
Success

boolean

None.

Messages

Collection of ErrorMessageModel

None.

Object

ResetPasswordModel

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "messages": [
    {
      "errorCode": "sample string 1",
      "friendlyMessage": "sample string 2"
    },
    {
      "errorCode": "sample string 1",
      "friendlyMessage": "sample string 2"
    }
  ],
  "object": {
    "email": "sample string 1",
    "ipAddress": "sample string 2",
    "clientId": "sample string 3"
  }
}