Web Service
i.Send API and Web Service.
The following operations are supported. For a formal definition, please review the Service Description.
-
CreateCampaign
MessageName="Campaigns.Create"
This method accepts a valid API Key, From Name, From Email, Subject, Contact Lists (Comma Separated List ID's), HTML Content, Plain Text Content. Returns Campaign ID as a string. -
DeleteCampaign
MessageName="Campaigns.Delete"
This method accepts a valid API Key and Campaign ID. Returns success as a boolean. -
GetDrafts
MessageName="Campaigns.GetDrafts"
This method accepts a valid API Key and returns all draft campaigns. -
GetScheduled
MessageName="Campaigns.GetScheduled"
This method accepts a valid API Key and returns all scheduled campaigns. -
GetSent
MessageName="Campaigns.GetSent"
This method accepts a valid API Key and returns all sent campaigns. -
AddToDoNotMail
MessageName="Contacts.AddToDoNotMail"
This method accepts a valid API Key and ContactID. Returns success as boolean. -
ContactInDoNotMail
MessageName="Contacts.ContactInDoNotMail"
This method accepts a valid API Key and Email. Returns success (found in list) as boolean. -
CreateSubscriberAdvanced
MessageName="Contacts.CreateSubscriberAdvanced"
This method accepts a valid API Key, Advanced Contact details. Returns Basic Details as a string. -
CreateSubscriberBasic
MessageName="Contacts.CreateSubscriberBasic"
This method accepts a valid API Key, Basic Contact details. Returns Basic Details as a string. -
GetBasicDetails
MessageName="Contacts.GetBasicDetails"
This method accepts a valid API Key ContactID. Returns Basic Details as a string. -
GetContactLists
MessageName="Contacts.GetContactLists"
This method accepts a valid API Key. Returns Number of Public Lists. -
GetDoNotMail
MessageName="Contacts.GetDoNotMail"
This method accepts a valid API Key and ContactID. Returns success as boolean. -
GetFullDetail
MessageName="Contacts.GetFullDetail"
This method accepts a valid API Key ContactID. Returns details as a string. -
GetPublicListCount
MessageName="Contacts.GetPublicListCount"
This method accepts a valid API Key. Returns Number of Public Lists. -
GetPublicLists
MessageName="Contacts.GetPublicLists"
This method accepts a valid API Key. Returns Public Lists. -
IsActive
MessageName="Contacts.IsActive"
This method accepts a valid API Key and contact ID. Returns Number of active as boolean. -
Subscribe
MessageName="Contacts.Subscribe"
This method accepts a valid API Key, ListID and ContactID. Returns Returns success as boolean. -
Unsubscribe
MessageName="Contacts.Unsubscribe"
This method accepts a valid API Key, ListID and ContactID. Returns Returns success as boolean. -
UpdateBasicDetails
MessageName="Contacts.UpdateBasicDetails"
This method accepts a valid API Key ContactID. Returns Basic Details as a string. -
CreateList
MessageName="Lists.Create"
This method accepts a valid API Key List Name. Returns List ID as a string. -
CreateListAdvanced
MessageName="Lists.CreateAdvanced"
This method accepts a valid API Key List Name, SuccessfulSubscriptionPage, RemoveSubscriptionPage. Returns List ID as a string. -
DeleteList
MessageName="Lists.Delete"
This method accepts a valid API Key ListID. Returns success as boolean. -
GetListDetail
MessageName="Lists.GetDetail"
This method accepts a valid API Key ListID. Returns list details as String. -
GetBounces
MessageName="Reports.GetBounces"
This method accepts a valid API Key and CampaignID and returns all of the bounces recieved: Email Address, Time of bounce. -
GetBouncesCount
MessageName="Reports.GetBouncesCount"
This method accepts a valid API Key and CampaignID and returns the number of bounces recieved. -
GetClicks
MessageName="Reports.GetClicks"
This method accepts a valid API Key and CampaignID and returns all of the clicks recieved: Email Address, Time of click. -
GetClicksCount
MessageName="Reports.GetClicksCount"
This method accepts a valid API Key and CampaignID and returns the number of clicks recieved. -
GetOpens
MessageName="Reports.GetOpens"
This method accepts a valid API Key and CampaignID and returns all of the opens recieved: Email Address, Time of open. -
GetOpensCount
MessageName="Reports.GetOpensCount"
This method accepts a valid API Key and CampaignID and returns the number of opens recieved. -
GetSummary
MessageName="Reports.GetSummary"
This method accepts a valid API Key and CampaignID and returns the summary of activity: Recipients, Opens, Clicks, Bounces.