Lets you post a custom activity on a Lead. Pass the “LeadId” in the JSON body to specify the lead you want to post the activity on.
Note: To include the updated lead score in the response, in the JSON payload, pass an additional parameter “IncludeLeadScore” : true
API URL
Request
JSON Body/Payload
Content-Type: application/json
{
"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"
}
]
}
JSON Properties
{ "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" } ] }
JSON Properties
Parameter | Description |
---|---|
RelatedProspectId | Lead Id (ProspectId) of the lead you want to post the activity on. |
ActivityEvent | Activity event code. |
ActivityNote | Activity note. |
ActivityDateTime | Activity date and time in yyyy-mm-dd hh:mm:ss format. |
Response
200 OK
Content-Type: application/json
{ "Status": "Success", "Message": { "Id": "0b14ace6-5df5-11e5-981b-22000a9700b4" } }
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. |