Update a Lead

Lets you update an existing lead. To use this API –

  • Pass the “LeadId” (or Prospect Id) in the API URL. To get the Lead Id, use the Get Lead by Email or Get Lead by Phone APIs.
  • Pass the fields you want to update as attribute-value pairs in the JSON body. Only the fields you pass will be updated, other fields won’t be impacted.

Note: If you have configured automation, webhooks or rules & notifications based on lead Update, they won’t trigger by default if a lead is updated via this API. If you want them to trigger, pass an additional parameter “postUpdatedLead=true” in the API URL as shown here –

POST https://api.leadsquared.com/v2/LeadManagement.svc/Lead.Update?accessKey=AccessKey&secretKey=SecretKey&leadId=leadid&postUpdatedLead=true

API URL

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

URL Parameters

Parameter Description
LeadId Unique Id of the lead.

Request

JSON Body/Payload

Content-Type: application/json

[
    {
        "Attribute": "Phone",
        "Value": "9999999999"
    },
    {
        "Attribute": "mx_City",
        "Value": "London"
    }
]

JSON Properties

Parameter Description
Phone

The lead’s phone number.

mx_City

Custom field for the lead’s city.

Response

200 OK

Content-Type: application/json

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

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.