Forgot Password

This API enables you to send a password reset email to the user based on the EmailAddress (registered email address) posted in the JSON body.

  • The response returns a LeadId and a TemporaryPassword
  • Both the LeadId and TemporaryPassword must be passed in the Reset Password API to create a new password

Here’s an example of the forgot password functionality in a sample portal. When users enter their email address, an email is sent with a reset password link.

forgot password api



Copy URL


JSON Body/Payload

Content-Type: application/json

  "EmailAddress": ""

JSON Properties

Parameter Description

Pass the user’s registered email address.


200 OK

Content-Type: application/json

  "EmailAddress": "",
  "LeadId": "a822e018-80a4-4a86-bd9d-9855710109ff",
  "TemporaryPassword": "12078b6f730c675484812414f8cd806a154b87735472460e1ff46126eed3f14c"

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.