Check-In User
Lets you check-in to LeadSquared.
- Pass the “Source” you’re checking-in from.
- All other parameters (“Location”, “Latitude”, “Longitude”, “AvailabilityStatus”, “OtherDetails”) are optional.
API URL
Request
Content-Type: application/json{ "Source" : "MobileApp", "Location" : "KA", "Latitude" : 38.578624, "Longitude" : -121.497595, "AvailabilityStatus" : "Online", "OtherDetails" : { "key1" : "value1" , "key2" : "value2" , "key3" : "value3" } }
Request Parameters
Parameter | Description |
---|---|
Source | The source the user is checking-in from. Sample values include ‘MobileApp’, ‘WebApp’, ‘API’, or anything relevant. |
Location | The location the user is checking-in from. The user can pass city name (Bangalore), state name (Karnataka), etc. |
Latitude | The latitude of the location the user is checking-in from. Only for mobile app check-ins. |
Longitude | The longitude of the location the user is checking-in from. Only for mobile app check-ins. |
AvailabilityStatus | The availability status of the user (Online, Away and Offline) |
OtherDetails | Users can enter any key-value pairs here to pass custom data related to checking-in. |
Response
{ "Status": "Success", "Message": { "ResponseText": "User successfully checked in on 2017-10-31 09:54:06" } }
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. |