POST api/Campaigns/GetEmailInteractions

When an email is sent there are a variety of actions that can happen with the email (we call these interactions). The following three interactions are available from this API: SNT - The email was sent, BBK - The email provider returned a message that the email couldn’t be delivered, similar to the Post Office sending back a letter or mailed item with a "Return to Sender". LNK - The recipient clicked on a link within the email.

Request Information

URI Parameters

None.

Body Parameters

EmailInteractionsRequestModel

Name	Description	Type	Additional information
EmailAddresses	(Required) - The email address(es) that you want to get the interactions, you can include up to 10 email addresses in each request.	Collection of string	None.
EmailID	(Required) – The email identifier for the email you want to get the interactions statistics. Use the GetEmails API to obtain the email id (this will only show reusable “Triggered” emails only).	string	None.
ActionType	Include one of the ActionTypes if you want to see that specific interaction that a person made with the email. If you leave this blank, then all possible interactions will be provided for that timeframe (see table above for the ActionTypes available through this API).	string	None.
StartDate	Starting date range. If you do not provide a date, this will default to 90 days in the past	date	None.
EndDate	Ending date range. if you do not provide a date, this will default to the current date and time	date	None.

Request Formats

application/json, text/json

Sample:

{
  "EmailAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "EmailID": "sample string 1",
  "ActionType": "sample string 2",
  "StartDate": "2025-10-23T21:19:55.6109987-06:00",
  "EndDate": "2025-10-23T21:19:55.6109987-06:00"
}

application/xml, text/xml

Sample:

<EmailInteractionsRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EmailAddresses>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </EmailAddresses>
  <EmailID>sample string 1</EmailID>
  <ActionType>sample string 2</ActionType>
  <StartDate>2025-10-23T21:19:55.6109987-06:00</StartDate>
  <EndDate>2025-10-23T21:19:55.6109987-06:00</EndDate>
</EmailInteractionsRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EmailInteractionsResponseModel

Name	Description	Type	Additional information
Interactions	List of email interactions	Collection of Interaction	None.
IsSuccessful	Indicator of whether the request was successful	boolean	None.
ErrorMessage	This will contain details of the error if it was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Interactions": null
}