REST API: PasswordReset/Begin

This endpoint sends an email to a user allowing them to change their password

Minimum API version: v2.0

Resource URI

/PasswordReset/Begin

Resource Properties

ParameterFormatDescriptionAllows Null
xxx xxx xxx xxx

Error Responses

HTTP GET

N/A

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP POST

Sends email with link that allows user to reset their password.

host parameter is optional. Valid values are:
TL
RTCORG
Any other value, or blank, will default to TL

JSON Request:

{
"email": "useremail@email.com",
"host": "RTCORG"
}

JSON Response:

XML Request:

XML Response:

HTTP PUT

N/A

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP DELETE

N/A

JSON Request:

JSON Response:

XML Request:

XML Response:


REST API: PasswordReset/Begin Set

N/A

Resource URI

Set Filters

ParameterFormatDescriptionAllows Null
xxx xxx xxx xxx

HTTP GET

N/A

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP POST

N/A

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP PUT

N/A

JSON Request:

JSON Response:

XML Request:

XML Response:

HTTP DELETE

N/A

JSON Request:

JSON Response:

XML Request:

XML Response: