LeadSquared Developer Centre

ON THIS PAGE

Change Password


Use this API to let users change their passwords once they’ve signed in to your portal. Pass the CurrentPassword and NewPassword in the JSON body.

Note: You must pass the public authentication key you receive from the Get Public Auth Key API response. It must be passed in the API header as Authorization = <Your Auth Key>

Here’s an example of change password functionality in a sample portal –

change password API

 

API URL

URL
Icon
POST https://{host}/api/Settings/ChangePassword?

Request

Content-Type: application/json
JSON Body/Payload Icon
{
  "CurrentPassword": "OldSamplepassword@123",
  "NewPassword": "NewSamplepassword@123"
}

Request Parameters

Parameter Description
CurrentPassword

Pass the user’s current password.

NewPassword

Pass the user’s new password.

Response

200 OK
Content-Type: application/json
{
  "IsSuccessful": true,
  "ResponseText": "Password changed successfully"
}

HTTP Response Codes

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.

On this page

© 2022 by MarketXpander Services Pvt Ltd. All Rights Reserved.