Surveys
These endpoints allow interactions with survey data.
API | Description |
---|---|
POST api/Surveys/GetSurveyResponseHistory |
Provides a list of emails that were sent with tracked surveys and whether the person responded to the survey. |
Campaigns
These endpoints allow interactions with email campaign data.
API | Description |
---|---|
POST api/Campaigns/GetRecipientHistory |
This endpoint provides a list of emails sent to the requested email addresses. It will allow up to 10 email addresses in one request. This will default to provide the emails sent over the last 90 days, but that parameter can be changed in the request. |
POST api/Campaigns/GetEmails?includeMergeFields={includeMergeFields} |
Provides a list of emails that can be used as part of the SendEmails API. This API has an option that allows you choose if you want to get the merge fields. For example, if you only need the email names and ids, you can choose not to get the merge fields and return results faster. |
POST api/Campaigns/SendEmails |
This API allows you to send emails from Digital Communication. To be used with the GetEmails API to know the EmailID, merge fields, etc. required to send the email. |
POST api/Campaigns/GetEmailPerformance |
Within Digital Communication Product Suite application, each email that has been sent has an Email Performance report that gives information about the email and interactions from the recipients. You can use this to get information on reusable “Triggered” emails only. |
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. |
POST api/Campaigns/GetUnsubscribesList |
This API allows you to retrieve the email addresses that have been unsubscribed from receiving emails from you. |
POST api/Campaigns/GetPermanentBlocks |
This API allows you to retrieve the email addresses that have been permanent blocked because we have received "Hard" bounce backs for that email address. |
POST api/Campaigns/GetBouncebacks |
This API allows you to retrieve all the bounce back or undeliverable messages we have received for your emails sent from Digital Communication. This will allow you to see these and act before the email is added to the permanent blocked list of emails. |
POST api/Campaigns/GetSentEmails |
This method will return a list of emails that were sent on the requested date. It requires a range. In this range, up to 5000 can be requested at a time. |