MailingService
MailingService Description: ASMX, WSDL
Add:
ASMX,
XML
Description: Add a new mailing to send at an undetermined date. Returns MessageID as Integer. Note: Must call Send(MessageID) function to send mailing.
Parameters: |
Name |
Type |
Description |
NewMail |
MailDataset.MailDataTable |
XSD |
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
MailDataset.MailDataTable |
XSD |
AddToSendLater:
ASMX,
XML
Description: Add a new mailing to send later. Returns MessageID as Integer.
Parameters: |
Name |
Type |
Description |
NewMail |
MailDataset.MailDataTable |
XSD |
SendDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
MailDataset.MailDataTable |
XSD |
AddToSendNow:
ASMX,
XML
Description: Add a new mailing to send now. Returns MessageID as Integer.
Parameters: |
Name |
Type |
Description |
NewMail |
MailDataset.MailDataTable |
XSD |
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
MailDataset.MailDataTable |
XSD |
ApprovalMailExists:
ASMX,
XML
Description: Check if a draft (unscheduled) mailing exists.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
Boolean |
|
DeleteApprovalMail:
ASMX,
XML
Description: Delete mailing in draft (unscheduled) queue.
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
Boolean |
|
DeleteSentMail:
ASMX,
XML
Description: Delete email that has already been sent.
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
Boolean |
|
ListDeliveredMailings:
ASMX,
XML
Description: List delivered mail recipients for a mailing.
CompletionStatusID value descriptions:
300 - The mail was sent successfully.
301 - The destination mail server reported a temporary failure error code (between 400 - 499).
302 - The destination mail server reported a permanent failure error code (500+).
303 - A temporary DNS failure occurred.
304 - The domain is reported to be bad via DNS.
305 - A bounce was received for this recipient.
306 - An attempt was made to send to an email address (rather than a contact/member ID) and that address is not syntactically valid.
307 - The message to send for this recipient was deleted from the database.
308 - The expiration date to send the mailing was reached before all attempts were completed.
309 - The recipient was not sent to because the mailing was stopped by an administrator.
310 - The recipient was not processed due to the skip command in mailmerge.
311 - The recipient was not sent to because the mailing was stopped during mail merging by the 'abort' command.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
MailDeliveredDataset.MailDeliveredDataTable |
XSD |
ListInProgressRecipients:
ASMX,
XML
Description: List in progress mail recipients for a mailing.
StatusID value descriptions:
0 - Recipient has not been attempted.
301 - The destination mail server reported a temporary failure error code (between 400 - 499).
303 - A temporary DNS failure occurred.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
InProgressRecipientDataset.ListInProgressRecipientsDataTable |
XSD |
ListMailingsForApproval:
ASMX,
XML
Description: List draft (unscheduled) mailings.
Parameters: |
none |
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ApprovalMailDataset.ApprovalMailDataTable |
XSD |
ListMailingStatistics:
ASMX,
XML
Description: Return statistics for a MailingID. Table of codes:
300 | The mail was sent successfully. |
301 | The destination mail server reported a temporary failure error code (between 400 - 499). |
302 | The destination mail server reported a permanent failure error code (500+). |
303 | A temporary DNS failure occurred. |
304 | The domain is reported to be bad via DNS. |
305 | A bounce was received for this recipient. |
306 | An attempt was made to send to an email address (rather than a contact/member ID) and that address is not syntactically valid. |
307 | The message to send for this recipient was deleted from the database. |
308 | The expiration date to send the mailing was reached before all attempts were completed. |
309 | The recipient was not sent to because the mailing was stopped by an administrator. |
310 | The recipient was not processed due to the skip command in mailmerge. |
311 | The recipient was not sent to because the mailing was stopped during mail merging by the 'abort' command. |
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
MailingStatisticsDataset.MailingStatisticsDataTable |
XSD |
ListScheduledMailings:
ASMX,
XML
Description: List mailings that are scheduled to send at a later date.
Parameters: |
none |
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
ApprovalMailDataset.ApprovalMailDataTable |
XSD |
ListSentMailings:
ASMX,
XML
Description: List mailings that have been sent.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
SentMailDataset.SentMailDataTable |
XSD |
ListSentMailingsSummary:
ASMX,
XML
Description: Return a summary of all mailings and their completion status in a given date range.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
MailingStatisticsDataset.SentMailingSummaryDataTable |
XSD |
ListTrackingSummary:
ASMX,
XML
Description: Return a summary of open and clicktracking for all mailings in a given date range.
Parameters: |
Name |
Type |
Description |
StartDate |
DateTime |
|
EndDate |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
PagingHeader: |
Name |
Type |
Description |
PageSize |
Int32 |
(Optional) The requested page size. |
PageNumber |
Int32 |
(Optional) The page number to retrieve. |
|
Return Value: |
Type |
Description |
MailingStatisticsDataset.TrackingSummaryDataTable |
XSD |
LoadMailingForApproval:
ASMX,
XML
Description: Load one draft (unscheduled) mailing.
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
ApprovalMailDataset.ApprovalMailDataTable |
XSD |
LoadSentMailing:
ASMX,
XML
Description: Load one mailing that has already been sent.
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
SentMailDataset.SentMailDataTable |
XSD |
ScheduleSend:
ASMX,
XML
Description: Schedule an existing mailing to send at a later date.
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
SendTime |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
Boolean |
|
ScheduleSendWithSendTimeOptimization:
ASMX,
XML
Description: Schedule an existing mailing to send at a later date with Send Time Optimization. The mailing will be sent to the recipient based on when they are most likely to engage. Recipients will be sent to over the 24-hour period following the send date.
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
SendTime |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
Boolean |
|
ScheduleSendWithTimeZoneSending:
ASMX,
XML
Description: Schedule an existing mailing to send at a later date with Time Zone Sending. Must be scheduled at least 24 hours into the future. If time zone is unknown, the default will be time zone set for account.
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
SendTime |
DateTime |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
Boolean |
|
Send:
ASMX,
XML
Description: Send an existing mailing now.
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
Boolean |
|
SendSpamTest:
ASMX,
XML
Description: Send a spam test mailing to a reciepient. Returns the ModerateID for the new test mailing.
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
ToAddress |
String |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
Int32 |
|
SendTest:
ASMX,
XML
Description: Send a test mailing to a reciepient. Returns the ModerateID for the new test mailing.
Parameters: |
Name |
Type |
Description |
MessageID |
Int32 |
|
ToAddress |
String |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
Int32 |
|
SentMailExists:
ASMX,
XML
Description: Check if a sent mailing exists.
Parameters: |
Name |
Type |
Description |
MailingID |
Int32 |
|
|
SoapHeader: |
Name |
Type |
Description |
Username |
String |
Your API access username. |
Password |
String |
Your API access password. |
List |
String |
The account you want to access. |
|
Return Value: |
Type |
Description |
Boolean |
|