API Reference

Request Password Reset

post
{protocol}://{domain}/helpdesk/auth/forgotten

Initiates a password reset process for users who have forgotten their password. Upon providing a valid email or username, the user will receive a token or link to proceed with the password reset.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Details required to initiate a password reset.

string

The email address for which the token is being requested. Must be a valid email format.

string

The token generated by the client-side reCAPTCHA widget. This token is used for server-side validation to confirm that the user's interactions are genuine.

string

The version of the reCAPTCHA widget being used. Knowing the version is essential for proper server-side validation.

Responses

Updated over 2 years ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago