Update a Lead
This downloads our complete API collection, including all endpoints—not just this specific endpoint.
Updates 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.
- If Object Types are enabled on your account, the field (
LeadType) value is set to OT_0 by default.- You can change the
LeadTypefrom the default value (OT_0) to a custom value (OT_1, OT_2, and so on) only once. After you change it, you cannot update it again.
- You can change the
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 –
https://api.leadsquared.com/v2/LeadManagement.svc/Lead.Update?accessKey=AccessKey&secretKey=SecretKey&leadId=leadid&postUpdatedLead=true
API URL
URL
POST
https://{host}/v2/LeadManagement.svc/Lead.Update?accessKey=AccessKey&secretKey=SecretKey&leadId=LeadId
URL Parameters
| Parameter | Description |
|---|---|
| LeadId | Unique Id of the lead. |
Request
Content-Type: application/jsonJSON Body/Payload
[
{
"Attribute":"Phone",
"Value":"+91-9988776655"
},
{
"Attribute":"mx_City",
"Value":"Chennai"
},
{
"Attribute":"LeadType",
"Value":"OT_1"
}
]
Request Parameters
| Parameter | Description |
|---|---|
| Attribute | The schema name of the lead fields you want to update. You can get these using the Get Metadata API. |
| Value | The new value of the lead field. |
| LeadType | If object types are enabled on your account, the LeadType value is OT_0 by default, and you can change it to a custom value (OT_1, OT_2, and so on) only once, after which you cannot update it again. This is optional. |
Response
200 OK
Content-Type: application/json
{
"Status":"Success",
"Message":{
"AffectedRows":1
}
}
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. |
