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-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 Post Activity on Lead Metrics API.
Note: The supported DateTime format is UTC (YYYY-MM-DD HH:MM:SS).
API URL
URL
POST
https://{async-host}/activity/create?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"RelatedProspectId":"00727844-51aa-11e2-9e64-12314004ac6b",
"ActivityEvent":201,
"ActivityNote":"Your Activity Note",
"ActivityDateTime":"2015-10-11 12:13:44",
"Fields":[
{
"SchemaName":"mx_Custom_1",
"Value":"123123123"
},
{
"SchemaName":"mx_Custom_2",
"Value":"123"
},
{
"SchemaName":"mx_Custom_3",
"Value":"3"
},
{
"SchemaName":"mx_Custom_4",
"Value":"4"
},
{
"SchemaName":"mx_Custom_5",
"Value":"2016-07-07 10:55:00"
},
{
"SchemaName":"mx_Custom_6",
"Value":"Value for Custom field"
},
{
"SchemaName":"mx_Custom_7",
"Value":"Value for Custom field"
},
{
"SchemaName":"mx_Custom_8",
"Value":"1"
},
{
"SchemaName":"mx_Custom_9",
"Value":"Value for Custom field"
},
{
"SchemaName":"mx_Custom_10",
"Value":""
},
{
"SchemaName":"mx_Custom_11",
"Value":""
},
{
"SchemaName":"mx_Custom_12",
"Value":""
},
{
"SchemaName":"mx_Custom_13",
"Value":"Value for Custom field"
},
{
"SchemaName":"mx_Custom_14",
"Value":"Value for Custom field"
},
{
"SchemaName":"mx_Custom_15",
"Value":"asd"
}
]
}
Request 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 UTC (yyyy-mm-dd hh:mm:ss) format. |
| Fields | Pass the activity fields (schema names) and values here. |
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. |
