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 –

  1. API host is different, see Async API.
  2. The URL is slightly different (see API URL below).
  3. An additional x-api-key must be passed in the header, see Async APIContent-Type is application-json.
  4. Returns a RequestId parameter in the response. This must be passed in the Status API to get the status of the request.

 

API URL

POST
https://{async-host}/lead/update?accessKey=AccessKey&secretKey=SecretKey&leadId=LeadId&postUpdatedlead=PostUpdatedLead
Copy URL

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

JSON Body/Payload

Content-Type: application/json

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

JSON Properties

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 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.