<p>APIConnector for integration with our email marketing system</p><li><strong>API usage is capped at 15,000 API calls per 24 hour period.</strong></li><li>You may only access this system when the account you are using has been granted API permission.</li><li>Furthermore, you may not use your main account - a separate login must be created within your account, for use with the API.</li><li>All datetime parameters are expected to be in UTC, and datetimes will be returned in UTC. Please call GetServerTime if in doubt.</li>
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.
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.
Retrieves a list of contacts who were modified between two specified dates.
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.
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.
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.
Retrieves a list of contacts who were modified between two specified dates, in a given address book.
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.
Retrieves a list of contacts who hard bounced when sending a particular campaign.
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.
Retrieves a list of contacts who hard bounced when sending a particular campaign, along with specified data labels.
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.
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.
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.
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.
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.
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.
Retrieves activity for a given contact and campaign.
Retrieves a list of unsubscribers who unsubscribed after a given date
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.
Creates a contact
Creates a contact data field
Deletes a contact data field
Updates an existing contact
Adds a contact to a given address book
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).
Removes all contacts 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).
Retrieves a contact status using an email address
Retrieves a contact using an email address
Retrieves a contact using the ID. Unsubscribed or suppressed contacts will not be retrieved.
<strong>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.</strong>
<strong>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.</strong>
Determines the import status of a previously started contact import.
Determines the send status using a token returned by SendCampaignToAddressBooksWithProgress.
Gets a report with statistics about what was successfully imported, and what was unable to be imported
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.
List all address books for the current account.
List all public address books for the current account.
List all private address books for the current account.
Returns a list of contact data labels in an account.
Lists any address books that a contact is in.
Lists any address books that a campaign has ever been sent to.
Lists any campaigns that have been sent to an address book.
Creates an address book
Deletes an address book
Returns the amount of contacts in a given address book.
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.
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.
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.
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.
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.
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.
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.
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.
Retrieves campaign forward or estimated forward information for a contact. Specify true using "getEstimated" to return estimated forwards.
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.
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.
Retrieves an account info.
Resubscribes a contact who is currently unsubscribed. Please refer to the documentation, as not all contacts are permitted to resubscribe
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).
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).
Lists available custom from addresses for the current account.
Changes the custom from address of a campaign.
Lists all sent campaigns, which have had activity after a specified date (e.g. clicks, opens).
Gets a specified campaign.
Indicates if the supplied campaign id is a split test campaign.
Gets a summary of reporting information for a specified campaign.
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.
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.
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.
Sends a campaign to a specified contact.
Creates a campaign. Will be validated before saving.
Updates a given campaign. Will be validated before saving.
Copies a given campaign returning the id of the new campaign.
Returns the UTC time as set on the server.
Creates a template. Will be validated before saving.
Updates a given template. Will be validated before saving.
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).
Gets a specified template.
Fetches the campaign image folder tree structure.
Creates a new campaign image folder.
Uploads a new campaign image to the specified folder.
Lists all uploaded documents.
Upload a document to the specified folder.
Creates a new document folder.
Fetches the document folder tree structure.
Adds a document to a campaign as an attachment.
Removes an attachment from a campaign.
Lists documents that are currently attached to a campaign.
Sends a single SMS message. Sufficient credit is required or this method will fail.
<p>APIConnector for integration with our email marketing system</p><li><strong>API usage is capped at 15,000 API calls per 24 hour period.</strong></li><li>You may only access this system when the account you are using has been granted API permission.</li><li>Furthermore, you may not use your main account - a separate login must be created within your account, for use with the API.</li><li>All datetime parameters are expected to be in UTC, and datetimes will be returned in UTC. Please call GetServerTime if in doubt.</li>