Update a Lead (Async)
Updates an existing lead in your account. Functionality is the same as the synchronous Update a Lead API, with the following differences –
- API host is different, see Async API.
- The URL is slightly different (see API URL below).
- An additional
x-api-keymust be passed in the header, see Async API.Content-Typeisapplication-json. - Returns a
RequestIdparameter in the response. This must be passed in the Status API to get the status of the request. - To get metrics for this Async API, see Get Update Lead Metrics API.
API URL
URL
POST
https://{async-host}/lead/update?accessKey=AccessKey&secretKey=SecretKey&leadId=leadId&postUpdatedLead=postUpdatedLead
URL Parameters
| Parameter | Description |
|---|---|
| leadId | The unique identifier of the lead you want to update. This parameter is mandatory. |
| postUpdatedLead | 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 this parameter in the query string as true. |
Request
Content-Type: application/jsonJSON Body/Payload
[
{
"Attribute":"Phone",
"Value":"9999999999"
},
{
"Attribute":"mx_City",
"Value":"London"
}
]
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. |
Response
200 OK
Content-Type: application/json
{
"Status":"Request accepted. Please use below request id to check the status",
"RequestID":"7ba60ab0-7054-4856-8590-1b5a9f904ad1"
}
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. |
