APIConnector for integration with our email marketing system

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 creates, or bulk updates, contacts. Import format can either be CSV or Excel. Must include one column called "Email". Any other columns will attempt to map to your custom data fields. Use this method to stay within your API limits.
• AddContactsToAddressBookWithProgress
  Bulk creates, or bulk updates, contacts. Import format can either be CSV or Excel. Must include one column called "Email". Any other columns will attempt to map to your custom data fields. The returned token (a GUID) can be used to query import progress. Use this method to stay within your API limits.
• AttachDocumentToCampaign
  Adds a document to a campaign as an attachment.
• CopyCampaign
  Copies a given campaign returning the id of the new campaign.
• CreateAddressBook
  Creates an address book
• CreateCampaign
  Creates a campaign. Will be validated before saving.
• CreateContact
  Creates a contact
• CreateDataField
  Creates a contact data field
• CreateDocumentFolder
  Creates a new document folder.
• CreateImageFolder
  Creates a new campaign image folder.
• CreateTemplate
  Creates a template. Will be validated before saving.
• DeleteAddressBook
  Deletes an address book
• DeleteDataField
  Deletes a contact data field
• DetachDocumentFromCampaign
  Removes an attachment from a campaign.
• 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.
• GetCampaignSendProgress
  Determines the send status using a token returned by SendCampaignToAddressBooksWithProgress.
• 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. Unsubscribed or suppressed contacts will not be retrieved.
• 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.
• GetContactStatusByEmail
  Retrieves a contact status using an email address
• GetCurrentAccountInfo
  Retrieves an account info.
• GetDocumentFolders
  Fetches the document folder tree structure.
• GetImageFolders
  Fetches the campaign image folder tree structure.
• GetServerTime
  Returns the UTC time as set on the server.
• GetTemplate
  Gets a specified template.
• IsSplitTestCampaign
  Indicates if the supplied campaign id is a split test campaign.
• 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.
• ListAvailableCustomFromAddresses
  Lists available custom from addresses for the current account.
• ListCampaignActivities
  Retrieves a list of contacts who were sent a campaign. You may not request more than 1000 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 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListCampaignAttachments
  Lists documents that are currently attached to a campaign.
• ListCampaignClickers
  Retrieves a list of clickers of a campaign, along with their statistics. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListCampaignClickers2
  Retrieves a list of clickers of a campaign, along with their statistics. You may not request more than 1000 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 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListCampaignContactClicks2
  Retrieves a list of campaign link clicks for a contact. You may not request more than 1000 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 1000 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 1000 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 1000 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 1000 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 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListCampaignPageViews
  Retrieves a list of page views for a campaign. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListCampaignRoiDetailSinceDate
  Retrieves a list of ROI information (including contactId) for a campaign since the specified date. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListCampaignSocialBookmarkViews
  Retrieves campaign social bookmark views for a campaign. You may not request more than 1000 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. If you have over 500 campaigns, please use ListCampaigns2 instead. Please note that only the basic campaign data will be returned (not the content).
• ListCampaigns2
  Lists all campaigns for the current account. 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. Please note that only the basic campaign data will be returned (not the content).
• 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. To list the contents of the "All Contacts" address book, select -1 as the addressBookId. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListContactsInAddressBookWithFullData
  Retrieves a list of contacts in a given address book, returning all data fields (slower; please consider ListContactsInAddressBook as a faster option). To list the contents of the "All Contacts" address book, select -1 as the addressBookId. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListDocuments
  Lists all uploaded documents.
• ListHardBouncesContacts2
  Retrieves a list of contacts who hard bounces when sending a particular campaign. You may not request more than 1000 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 1000 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.
• ListModifiedContacts2
  Retrieve a list of modified contacts after a specified date. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListModifiedContactsInAddressBook
  Retrieves a list of contacts who were modified between two specified dates, in a given address book.
• ListModifiedContactsInAddressBook2
  Retrieves a list of contacts who were modified since a given date, in a given address book. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListNewContacts
  Retrieve a list of new contacts, created after a specified date. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListPrivateAddressBooks
  List all private address books for the current account.
• ListPublicAddressBooks
  List all public address books for the current account.
• ListSentCampaignsWithActivitySinceDate
  Lists all sent campaigns, which have had activity after a specified date (e.g. clicks, opens).
• ListSuppressedContacts
  Retrieve a list of suppressed contacts along with the reason for suppression.You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• ListTemplates
  Lists all templates for the current account. 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. Please note that only the basic template data will be returned (not the content).
• 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. You may not request more than 1000 records at a time using the "select" parameter. Use the select and skip feature to retrieve all information.
• RemoveAllContactsFromAddressBook
  Removes all contacts from a given address book. The parameters 'preventAddressbookResubscribe' and 'totalUnsubscribe' are deprecated and do nothing.
• 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).
• ResubscribeContact
  Resubscribes a contact who is currently unsubscribed. Please refer to the documentation, as not all contacts are permitted to resubscribe
• SendCampaignToAddressBooks
  Sends a specified campaign to one or more address books at a specified time. Leave the address book array empty to send to All Contacts.
• SendCampaignToAddressBooksWithProgress
  Sends a specified campaign to one or more address books at a specified time. The returned token (a GUID) can be used to query send progress. Leave the address book array empty to send to All Contacts.
• SendCampaignToContact
  Sends a campaign to a specified contact.
• SendSingleSMSMessage
  Sends a single SMS message. Sufficient credit is required or this method will fail.
• SendSplitTestCampaignToAddressBookWithProgress
  Sends a specified split test campaign to one or more address books at a specified time. The returned token (a GUID) can be used to query send progress. Leave the address book array empty to send to All Contacts.
• SetCampaignCustomFromAddress
  Changes the custom from address of a campaign.
• UpdateCampaign
  Updates a given campaign. Will be validated before saving.
• UpdateContact
  Updates an existing contact
• UpdateTemplate
  Updates a given template. Will be validated before saving.
• UploadDocument
  Upload a document to the specified folder.
• UploadImage
  Uploads a new campaign image to the specified folder.