Update Campaign Interactions

⚠️

Legacy Endpoint Notice

This endpoint is now considered legacy. For all new and updated integrations, we strongly recommend using the new External Vendors Campaign Engagement Metrics endpoint, which offers improved performance and more features.

Rate Limit

This endpoint is subject to the general API rate limit of 50 requests per 10 seconds. Learn more about handling rate limits.

Notes

• When not supplied, RecipientGroupID defaults to 1, which is the test group in case of a test/control campaign or the A group in the case of an A/B campaign.
• The CustomerIDs array may contain a maximum of 10,000 rows (customers) each time this function is called.
• Available ChannelID values can be seen here, and you can also retrieve the available execution channel IDs and associated channel names using the GetExecutionChannels function.
• This function should be called upon each new campaign interaction. Optimove will aggregate the number of interactions based on the provided data upon multiple calls with the same parameters. This will allow users to have the campaign analysis channel metrics as clickable numbers. Once clicked, the list of interacted customers will be displayed in Optimove’s customer explorer.
• This function does not return a payload. A successful call will return a response code of 200 (success). Refer to an explanation of the other possible response codes at Error Handling
• The InteractionDate field is mandatory.

Sample Request

{
  "CampaignID":324,
  "ChannelID":15,
  "InteractionDate":"2018-06-26",
  "TemplateID":8,
  "EventID":2,
  "RecipientGroupID":2,
  "CustomerIDs":
  	["A8272","A916537","A13521","A286571","A792414"],
  "AppID":"app123"
}

Sample Response

None