API
APIConnector for integration with our email marketing system. You may only access this system when the account you are using has been granted API permission. Furthermore, you may not use your main account - a managed login must be used.
The following operations are supported. For a formal definition, please review the Service Description.
-
AddContactToAddressBook
Adds a contact to a given address book -
AddContactsToAddressBook
Adds contacts in bulk to a given address book. Import format can either be CSV or Excel. -
CreateAddressBook
Creates an address book -
CreateCampaign
Creates a campaign. Will be validated before saving. -
CreateContact
Creates a contact -
CreateDataField
Creates a contact data field -
GetAddressBookContactCount
Returns the amount of contacts in a given address book. -
GetCampaign
Gets a specified campaign. -
GetCampaignContactForwardInfo
Retrieves campaign forward or estimated forward information for a contact. Specify true using "getEstimated" to return estimated forwards. -
GetCampaignSummary
Gets a summary of reporting information for a specified campaign. -
GetContactByEmail
Retrieves a contact using an email address -
GetContactById
Retrieves a contact using the ID -
ListAddressBooks
List all address books for the current account. -
ListAddressBooksForCampaign
Lists any address books that a campaign has ever been sent to. -
ListAddressBooksForContact
Lists any address books that a contact is in. -
ListCampaignActivities
Retrieves a list of contacts who were sent a campaign. You may not request more than 500 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information. -
ListCampaignContactActivity
Retrieves activity for a given contact and campaign. -
ListCampaignContactClicks
Retrieves a list of campaign link clicks for a contact. You may not request more than 500 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information. -
ListCampaignContactOpens
Retrieves a list of campaign opens for a contact. You may not request more than 500 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information. -
ListCampaignContactPageViews
Retrieves a list of page views for a contact. You may not request more than 500 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information. -
ListCampaignContactReplies
Retrieves a list of campaign replies for a contact. You may not request more than 5 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information. -
ListCampaignContactRoiDetail
Retrieves a list of ROI information for a contact. You may not request more than 500 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information. -
ListCampaignContactSocialBookmarkViews
Retrieves campaign social bookmark views for a contact. You may not request more than 500 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information. -
ListCampaigns
Lists all campaigns for the current account. -
ListCampaignsForAddressBook
Lists any campaigns that have been sent to an address book. -
ListContactDataLabels
Returns a list of contact data labels in an account. -
ListHardBouncesContacts2
Retrieves a list of contacts who hard bounces when sending a particular campaign. You may not request more than 500 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information. -
ListHardBouncingContacts
Retrieves a list of contacts who hard bounced when sending a particular campaign. -
ListHardBouncingContactsWithLabels
Retrieves a list of contacts who hard bounced when sending a particular campaign, along with specified data labels. -
ListHardBouncingContactsWithLabels2
Retrieves a list of contacts who hard bounced when sending a particular campaign, along with specified data labels. You may not request more than 500 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information. -
ListModifiedContacts
Retrieves a list of contacts who were modified between two specified dates. -
ListUnsubscribers
Retrieves a list of unsubscribers who unsubscribed after a given date -
RemoveAllContactsFromAddressBook
Removes all contacts from a given address book -
RemoveContactFromAddressBook
Removes or unsubscribes a contact from a given address book. If the address book ID supplied is -1, and totalUnsubscribe is true, the contact will be generally unsubscribed. -
SendCampaignToAddressBooks
Sends a specified campaign to one or more address books at a specified time. -
SendCampaignToContact
Sends a campaign to a specified contact. -
UpdateCampaign
Updates a given campaign. Will be validated before saving. -
UpdateContact
Updates an existing contact