Post an Activity on an Opportunity
Lets you post a custom activity on an Opportunity. The LeadId
, OpportunityId
and ActivityEvent
are mandatory in the JSON body, to specify the opportunity you want to post the activity on. You can get theOpportunityId
for an opportunity by referring to Get Opportunity by Lead Id.
Note: The supported DateTime format is UTC (YYYY-MM-DD HH:MM:SS).
API URL
Request
Content-Type: application/json{ "RelatedProspectId":"69e1c27e-dd08-4b53-b509-f353ad1c7f4d", "RelatedOpportunityId":"5ca5b042-51ea-4699-b6f0-84c40ab12770", "ActivityEvent":167, "ActivityNote":"Your Activity Note", "ActivityDateTime":"2020-09-15 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" } ] }
Request Parameters
Parameter | Description |
---|---|
RelatedProspectId | Lead Id (ProspectId) of the lead you want to post the activity on. |
RelatedOpportunityId | Opportunity Id of the opportunity you want to post the activity on. |
ActivityEvent | Activity event code. To obtain the activity event code, navigate to My Profile>Settings>Leads>Activities and Scores>Custom Activities and Scores. Against the Display Name, you’ll find the Code. |
ActivityNote | Activity note. |
ActivityDateTime | Activity date and time in UTC (YYYY-MM-DD HH:MM:SS). |
Fields | The activity fields you want to update. Pass the fields as attribute-value pairs, by mentioning the “Schema Names” and the values for it. To find the “Schema Names” to a custom activity, navigate to My Profile>Settings>Leads>Activities and Scores>Custom Activities & Scores . Against the activity type, click the icon, and then click Edit. You’ll find the “Schema Names” for the activity fields here. |
Response
{ "Status": "Success", "Message": { "Id": "f63b3aa5-4cd8-40ad-9dbb-a676c1f2edbd", "RelatedId": "69e1c27e-dd08-4b53-b509-f353ad1c7f4d" } }
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. |