Post Bulk Activities on Opportunities

Let’s you post bulk activities on single and multiple opportunities at one go.

  • Specify the opportunity by passing the OpportunityId in the query string. You can get this by calling the Get Opportunity by Lead Id API.
  • You can multiple objects with ActivityEventand ActivityOwnerEmail in the JSON body, to specify the activities you want to post on the opportunity.

Notes:

  • You can post up to 25 activities in a single call.
  • The user calling this API must have access to view the associated lead and opportunity.
  • You can also pass custom fields by specifying their “SchemaNames” and “Values” within the Fieldsparameter.

 

API URL

POST
https://{host}/v2/ProspectActivity.svc/Bulk/CustomActivity/Add/ByOpportunityId?accessKey=AccessKey&secretKey=SecretKey&opportunityId=opportunityId
Copy URL

URL Parameters

Parameter Description
opportunityId Opportunity Id of the opportunity you want to post the activities to.

Request

JSON Body/Payload

Content-Type: application/json

[
   {
      "ActivityEvent":208,
      "ActivityNote":"PAN collected",
      "ActivityOwnerEmail":"sri.sudhan@example.com",
      "Fields":[
         {
            "SchemaName":"mx_Custom_2",
            "Value":"AAAAA1111A"
         }
      ]
   },
   {
      "ActivityEvent":102,
      "ActivityNote":"Meeting completed",
      "ActivityOwnerEmail":"sri.sudhan@example.com"
   }
]

JSON Properties

Parameter Description
ActivityEvent

Activity event code. This is a mandatory field.

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

The activity note you want to post.

ActivityOwnerEmail

Email Id of the activity owner. This is a mandatory field.

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 edit icon, and then click Edit. You’ll find the “Schema Names” for the activity fields here.

Response

200 OK

Content-Type: application/json

{
   "Response":[
      {
         "ProspectActivityId":"c965269e-754c-4c4f-9b75-714ae56aa4af",
         "RowNumber":1,
         "ActivityCreated":true
      },
      {
         "ProspectActivityId":"dbeeedbc-4fbd-4547-a7bf-04a940dd82e6",
         "RowNumber":2,
         "ActivityCreated":true
      }
   ]
}

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.