Check-Out User

Lets you check-out of LeadSquared.

  • You must pass the ‘Source” you’re checking-out from.
  • All other parameters (“Location”, “Latitude”, “Longitude”, “AvailabilityStatus”, “OtherDetails”) are optional. However, if you do specify the “AvailabilityStatus” during check-out, the only accepted value is “Offline” (not case sensitive, so “OFFLINE”, “offline”, “Offline” will all work).

API URL

POST
https://{host}/v2/UserManagement.svc/User/CheckOut?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{ 
  "Source" : "MobileApp",
  "Location" : "KA",
  "Latitude" : 38.578624,
  "Longitude" : -121.497595,
  "AvailabilityStatus" : "Offline",
  "OtherDetails" : { "key1" : "value1" , "key2" : "value2" , "key3" : "value3" }
}

JSON Properties

Parameter Description
Source

The source the user is checking-out from. Sample values include ‘MobileApp’, ‘WebApp’, ‘API’, or anything relevant.

Location

The location the user is checking-out from. The user can pass city name (Bangalore), state name (Karnataka), etc.

Latitude

The latitude of the location the user is checking-out from. Only for mobile app check-outs.

Longitude

The longitude of the location the user is checking-out from. Only for mobile app check-outs.

AvailabilityStatus

The availability status of the user can only be ‘Offline’ while checking-out.

OtherDetails

Users can enter any key-value pairs here to pass custom data related to the checking-out.

Response

200 OK

Content-Type: application/json

{
    "Status": "Success",
    "Message": {
        "ResponseText": "User successfully checked out on 2017-10-31 9:55:10"
    }
}

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.