Sends an email so that the user can reset their password

Request

POST https://api.yourpayroll.com.au/api/v2/ess/security/forgottenpassword

Request body

The request body takes a complete RecoverPasswordModel resource, containing the following writable properties:

{
    "messageType": "string",
    "username": "string"
}

Properties

Name Type
messageType string
username string

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK