Portal Auto Login – Generate Lead-Level Auth Key
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Generates auth key to auto-login a specific lead to a portal.
- In the API URL, pass the Tenant (Account) Auth Key obtained in the Generate Tenant Level Auth Key response.
- Pass the
LeadIdandPortalIdin the JSON body. - The response returns an alpha-numeric auth key. Append this auth key to the target portal page URL along with the
LeadIdandPortalId(e.g., apply.lsqportal.com?leadId=&portalId=&authKey=) and share it with the lead (e.g., via email, SMS, etc.).
Note:
- The token is valid for only 4 hours. To change this duration, contact your account manager or support@leadsquared.com.
- You must use the correct API host to make successful calls.
API URL
URL
POST
https://{host}/api/AutoLogin/Generate?authkey=authkey
URL Parameters
| Parameter | Description |
|---|---|
| authkey | Auth key obtained from 'Generate Tenant Auth Key' API. |
Request
Content-Type: application/jsonJSON Body/Payload
{
"LeadId": "eb7bdb1c-8402-4902-96bf-6aec76a73585",
"PortalId": "0a492bed-5a23-11eb-94c0-0a6b76cb2a1a"
}
Request Parameters
| Parameter | Description |
|---|---|
| LeadId | Use any of the ‘Retrieve Lead’ APIs to get the |
Response
200 OK
Content-Type: application/json
{
"AuthKey": "ZjloNzcrWnNiVitQQWVDanA0OUpSb0xtU25lWE44YXBIS0VzdFJuSlhoemtTS2tUamM1Z3hZN2NuVFBkSUFIamRzQzdsSlZMT1VaNVRzOUxyZzF4ZEhHTUMxOHlkcjB0bVVJenoyeHJ4TmZXZDZRMStMVW9hMVh5R3hNVFgyVnNjbUFXYlhabnpNOFhJcDlaQ3kwWmxFSEc2cnpiSWFQS",
"LeadId": "eb7bdb1c-8402-4902-96bf-6aec76a73585"
}
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. |
