Add Leads to a Static List

Lets you add leads to an existing static list. To use this API –

  • Pass the “ListId” of the static list you want to add leads to in the JSON body.
  • Pass the “LeadIds” of the leads you want to add in the JSON body. You can add one or more leads using this API.

Note: Duplicate leads won’t get added.

API URL

POST
https://{host}/v2/LeadSegmentation.svc/AddLeadsToStaticList?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
     "listId":"1202c312-6ac7-11e7-9042-22000aa79843",
     "leadIds":["2c415e0e-4ded-410c-b231-8fa5e318d222",”b852f5db-580e-4d0a-b7ff-228b013fe85b”,]
} 

JSON Properties

Parameter Description
listId

Unique Id of the list. Please refer the List Management section of apidocs.leadsquared.com for more details.

LeadId

Unique Id of the lead you want to add to the static list.

Response

200 OK

Content-Type: application/json

{
    "Status": "Success",
    "Message": {
        "Message": "Successfully added 2 lead(s) to list"
    }
}

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.