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
  Bulk adds, or bulk updates, contacts. Import format can either be CSV or Excel. Use this method to stay within your API limits.
• AddContactsToAddressBookWithProgress
  Bulk adds, or bulk updates, contacts. Import format can either be CSV or Excel. The returned token (a GUID) can be used to query import progress. Use this method to stay within your API limits.
• 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
• GetContactImportProgress
  Determines the import status of a previously started contact import.
• GetContactImportReport
  Gets a report with statistics about what was successfully imported, and what was unable to be imported
• GetContactImportReportFaults
  Gets all records that were not successfully imported. The data are returned in a base64 encoded CSV file, which is UTF-8 encoded. This data will only be available for approximately one week after import.
• 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.
• ListCampaignActivitiesSinceDate
  Retrieves a list of contacts who were sent a campaign, and retrieves only those contacts who responded (e.g. clicked, opened) after a specified date. 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.
• ListCampaignClickers
  Retrieves a list of clickers of a campaign, along with their statistics. 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.
• ListCampaignOpeners
  Retrieves a list of openers of a campaign, along with their statistics. 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.
• ListContactsInAddressBook
  Retrieves a list of contacts in a given address book
• ListContactsInAddressBookWithFullData
  Retrieves a list of contacts in a given address book, returning all data fields (slower; please consider ListContactsInAddressBook as a faster option)
• 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.
• ListModifiedContactsInAddressBook
  Retrieves a list of contacts who were modified between two specified dates, in a given address book
• ListSentCampaignsWithActivitySinceDate
  Lists all sent campaigns, which have had activity after a specified date (e.g. clicks, opens).
• ListUnsubscribers
  Retrieves a list of unsubscribers who unsubscribed after a given date
• ListUnsubscribersAddressBook
  Retrieves a list of contacts who have unsubscribed from a given address book
• RemoveAllContactsFromAddressBook
  Removes all contacts from a given address book
• RemoveContactFromAddressBook
  Removes or unsubscribes a contact from a given address book. If totalUnsubscribe is set to true, the contact will be completely removed from the account (you may wish to specify -1 as the addressbook ID in this case).
• 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