The following operations are supported. For a formal definition, please review the Service Description.
|
The following API method calls are available through SOAP which gives you easy access to most functionality found in the system.
Email_Add
Add an email to your account.
Email_AddWithFields
Add an email to your account and populate custom fields.
Email_Change
Change an email address.
Email_Delete
Delete an email from your account.
Email_GetHistory
Get a list of history items for an email address.
Email_GetProperties
Get a list of all properties associated with an email address.
Email_Remove
Remove an email from your account or a specific publication.
Email_Update
Update an existing email within your account.
Account
Account_GetActiveEmails
Get list of all active emails in your account.
Account_GetActiveEmails_Simple
Get list of all active emails in your account without full records.
Account_GetComplaints
Get list of subscribers that have complained.
Account_GetComplaints_Simple
Get list of subscribers that have complained without full records.
Account_GetDatabaseFields
Get custom columns
Account_GetGlobalRemoves
Get list of subscribers that have globaly removed from your account.
Account_GetGlobalRemoves_Simple
Get list of subscribers that have globaly removed from your account without full records.
Account_GetHardBounces
Get list of subscribers that have bounced.
Account_GetHardBounces_Simple
Get list of subscribers that have bounced without full records.
Account_GetIPInformation
Get IP Information
Account_UpdateFromDomain
Update The From Domain
Account_UpdateFromEmail
Update Default From Email Address
Account_UpdateReplyToEmail
Update the Reply To Email Address for your account
Lists
List_Add
Add a new list to your account.
List_Delete
Delete a list from your account.
List_GetAll
Get all the Lists in your account.
List_GetMembers
This method will return a list of all subscribers associated with a specific list.
Sources
Source_Add
Add a new source to your account.
Source_Delete
Delete a source from your account.
Source_GetAll
Get all the Sources in your account.
Publications
Publication_Add
Add a new Publication to your account.
Publication_Delete
Delete a Publication from your account.
Publication_GetAll
Get all the Publications in your account.
Publication_GetSubscribers
Get list of subscribers for a specific publication.
Publication_GetUnsubscribes
Get list of removes for a specific publication.
Suppression Lists
SuppressionList_Add
Add a new Suppression List to your account.
SuppressionList_AddDomains
Add one or more domains to a Suppression List.
SuppressionList_AddEmails
Add one or more emails to a Suppression List.
SuppressionList_Delete
Delete a Suppression List from your account.
SuppressionList_GetAll
Get all the Suppression Lists in your account.
SuppressionList_GetMembers_Simple
Get list of subscribers for a specific filter without full records.
Campaigns
Campaign_Add
Create a new draft campaign.
Campaign_Copy
Makes a copy of a configured campaign.
Campaign_GetClicks
Get list of subscribers that have clicked on a campaign.
Campaign_GetClicksForLink
Get list of subscribers that have clicked on a specific link.
Campaign_GetComplaints
Get list of subscribers that have complained about a campaign.
Campaign_GetHardBounces
Get list of subscribers that have bounced from a campaign.
Campaign_GetListDrafts
Get list of campaign drafts.
Campaign_GetListScheduled
Get list of scheduled campaigns.
Campaign_GetListSent
Get list of campaigns sent.
Campaign_GetOpens
Get list of subscribers that have opened a campaign.
Campaign_GetRecipients
Get list of subscribers the campaign was sent to.
Campaign_GetRemoves
Get list of subscribers that have removed from a campaign.
Campaign_GetSummary
Get a summary of the campaigns results.
Campaign_Schedule
Schedule a campaign.
Stats
Stats_DayOfWeek
Get aggregated stats for a time span, grouped by day of the week.
Stats_DomainOverTime
Get stats for a Domain over time.
Stats_Hourly
Get aggregated stats for a time span, grouped by hour of the day.
Stats_OverTime
Get stats over a specified time span.
Stats_SourceOverTime
Get stats for a Source over time.
Stats_Summary
Get stats for an account over a specified time span.
Stats_TopDomains
Get aggregated stats grouped by Domain.
Stats_TopSources
Get aggregated stats grouped by Source.
Creatives
Creative_Add
Add a new creative to your account.
Creative_CreateFolder
Create a new folder to organize your creatives.
Creative_GetCreativesForFolder
Get all creatives in a folder.
Creative_GetFolders
Get a tree of all creative folders in your account.
Relay Sends
RelaySend_CreateCategory
Create a RelaySend Category.
RelaySend_GetCategories
Get all the Relay Send Categories in your account.
RelaySend_GetCategoryStats
Get the stats for a specific Relay Send Category.
RelaySend_GetCategoryStatsForTags
Get the stats for a specific Relay Send Category and Tags.
RelaySend_GetDetailsForReceipt
Get Relay Send Stats for a specific Receipt ID
RelaySend_GetHardBounces
Get Hard Bounces for a RelaySend Category.
RelaySend_GetSoftBounces
Get Soft Bounces for a RelaySend Category.
RelaySend_GetSummaryForReceipts
Get Relay Send Summaries for a list of Receipt IDs
RelaySend_SendEmail
Relay emails through our system for tracking.
RelaySend_SendEmailVars
Relay emails through our system for tracking (With Variables).
Workflows
Workflow_AddExistingEmails
Add existing emails to a workflow.
Workflow_AddToWorkflows
Add an email to multiple workflows.
Workflow_GetAll
Get all the Workflows in your account.
Workflow_GetSendNodes
Get a list of all the "Send Nodes" in a workflow.
Workflow_GetStats
Get the stats for a specific workflow for a given time period.
Workflow_GetStatsForSendNode
Get the stats for a specific workflow "Send Node" for a given time period.
Workflow_RemoveEmails
Remove emails from a workflow.
Workflow_Start
Start a workflow.
Workflow_Stop
Stop a workflow.
Filters
Filter_GetAll
Get all the Filters in your account.
Filter_GetSubscribers
Get list of subscribers for a specific filter.
Filter_GetSubscribers_Simple
Get list of subscribers for a specific filter without full records.
ShortUrls
ShortUrl_Create
Create a ShortUrl to use for tracking purposes.
ShortUrl_GetStats
Get statistics for a ShortUrl.
ShortUrl_UpdateLink
Update the destination link for a ShortUrl.
Private Label
PrivateLabel_CreateAccount
Create a child account (Private Label Clients).
PrivateLabel_GetChildAccounts
Get child accounts (Private Label Clients).
PrivateLabel_SetAPIPassword
Set a child accounts API password (Private Label Clients).
PrivateLabel_SetEmailLimit
Set the max number of emails that an account can send in any given month.
|
These simple interfaces do not contain any complex structures which will allow you to use the API with a simple HTTP GET or POST.
Email_Add_Simple
Simple interface to add emails.
Email_Delete_Simple
Simple interface to delete emails.
Email_Remove_Simple
Simple interface to remove emails.
|