Post an Activity on a Lead (Async)
Posts an activity on a lead. Functionality is the same as the synchronous Post Activity on 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-key
must be passed in the header, see Async API.Content-Type
isapplication-json
. - Returns a
RequestId
parameter 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 Post Activity on Lead Metrics API.
API URL
Request
Content-Type: application/jsonRequest Parameters
Parameter | Description |
---|---|
RelatedProspectId | Lead Id (ProspectId) of the lead you want to post the activity on. |
ActivityEvent | Activity Event Code that specifies the activity type. Get it using Get List of Activity Types API. |
ActivityNote | Notes related to the activity. |
ActivityDateTime | Activity date and time in yyyy-mm-dd hh:mm:ss format. |
Fields | Pass the activity fields (schema names) and values here. |
Response
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. |