Update Leads in Bulk

Lets you to update the value of any one field for a maximum of 50 leads.

For example, you can bulk update the lead field “City” (schema name: “mx_City”) to “Bangalore” for 20 leads. To use this API –

  • Pass one or more “LeadIds” in the JSON body.
  • Pass the schema name of the field in the “Attribute” parameter and the new value in the “Value” parameter.

If you want to update one lead at a time, use the Update Lead API.

API URL

POST
https://{host}/v2/LeadManagement.svc/Lead/Bulk/Update?accessKey=AccessKey&secretKey=SecretKey
Copy URL

Request

JSON Body/Payload

Content-Type: application/json

{
    "LeadIds": [
        "xxxxxxxx-Lead-Idxx-xxxx-xxxxxxxxxxxx",
        "000a9a89-67f1-4e24-ab70-f89e4b667738"
    ],
    "LeadFields": 
        {
            "Attribute": "mx_City",
            "Value": "Bangalore"
        }
}

JSON Properties

Parameter Description
LeadIds

Pass one or more lead Ids (or Prospect Ids).

mx_City

Custom field for the lead’s city.

Response

200 OK

Content-Type: application/json

{
    "Status": "Success",
    "Message": {
        "AffectedRows": 2
    }
}

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.