POST api/v1/passwordReset

Sends a email with a link to a password reset url for the username provided

Request Information

URI Parameters

None.

Body Parameters

PasswordReset
NameDescriptionTypeAdditional information
UserName

string

Required

Request Formats

application/json, text/json

Sample: 
{
  "UserName": "email@example.com"
}

application/xml, text/xml

Sample: 
<PasswordReset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FreedomVoice.WebLink.Controllers">
  <UserName>email@example.com</UserName>
</PasswordReset>

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 'PasswordReset'.

Response Information

Resource Description

200 status code if email was successfully sent. 404 status code if user with that username was not found.

None.