POST api/v{version}/users/forgot

Create a password reset token for specified user and send it to user's phone or email..

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

ForgotPasswordModel
NameDescriptionTypeAdditional information
UserTypeId

byte

Required

Range: inclusive between 1 and 2

UserKey

string

Required

Request Formats

application/json, text/json

Sample:
{
  "UserTypeId": 64,
  "UserKey": "sample string 1"
}

application/xml, text/xml

Sample:
<ForgotPasswordModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FastFixCore.Controllers">
  <UserKey>sample string 1</UserKey>
  <UserTypeId>64</UserTypeId>
</ForgotPasswordModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ForgotPasswordModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.