This API registers a user on your portal. A corresponding lead will get created in your LeadSquared account. You may pass additional lead attributes, however, it is mandatory to pass the following attributes in the JSON body –
- EmailAddress
- mx_Portal_Password
- mx_Portal_Confirm_Password
Note: You must pass the public authentication key you receive in 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 an academic portal where a user can register. On clicking the ‘Get Started’ button, the Register API gets called –
API URL
Request
JSON Body/Payload
Content-Type: application/json
{
"LeadFields": [
{
"Attribute": "mx_Portal_Confirm_Password",
"Value": "Qwerty@1"
},
{
"Attribute": "mx_Portal_Password",
"Value": "Qwerty@1"
},
{
"Attribute": "EmailAddress",
"Value": "johnwick@example.com"
}
]
}
JSON Properties
{ "LeadFields": [ { "Attribute": "mx_Portal_Confirm_Password", "Value": "Qwerty@1" }, { "Attribute": "mx_Portal_Password", "Value": "Qwerty@1" }, { "Attribute": "EmailAddress", "Value": "johnwick@example.com" } ] }
JSON Properties
Parameter | Description |
---|---|
LeadFields | Pass the Attribute (Schema names of lead fields) and Value of the lead fields you want to accept. |
Response
200 OK
Content-Type: application/json
{ "LeadId": "e3e1f3d5-17c7-422e-b2ff-752069e5a010", "Message": "Registration Successful" }
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. |