Services

Name	Description
username	Your API access username.
password	Your API access password.
listname	The account you want to access.

Parameters:
none
Return Value:
Type	Description
String

GET
Description: List all categories for the current list.

Parameters:
none
Return Value:
Type	Description
CategoryDataset.CategoryDataTable

POST: JSON
Description: Add new categories.

Parameters:
Name	Type	Description
behavior	String	Behavior to apply when modifying categories ADD -> add missing categories, error on existing categories; UPDATE -> ignore missing categories, update existing categories (default: ADD)
categories	CategoryDataset.CategoryDataTable	The list of categories to add. NOTE: Adding a category with IsReadOnly set to 'True' will NOT allow deleting and only allow updates to Description and DirectoryID.
Return Value:
Type	Description
CategoryDataset.CategoryDataTable	See additional documentation.

/Services.svc/Categories/{categoryNameOrId}

GET
Description: Load a category by its id or name.

Parameters:
Name	Type	Description
categoryNameOrId	String	The category name or category id.
Return Value:
Type	Description
CategoryDataset.CategoryDataTable

DELETE
Description: Delete a category by its id or name.

Parameters:
Name	Type	Description
categoryNameOrId	String	The category name or category id.
Return Value:
Type	Description
Boolean

/Services.svc/Categories/{categoryNameOrId}/Contacts

GET
Description: List all contacts for a category.

Parameters:
Name	Type	Description
categoryNameOrId	String	The category name or category id.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
CategoryMemberDataset.CategoryMemberDataTable

/Services.svc/Categories/{categoryNameOrId}/Contacts/JoinRange

GET
Description: List all contacts for a category added within the given timeframe.

Parameters:
Name	Type	Description
categoryNameOrId	String	The category name or category id.
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
CategoryMemberDataset.CategoryMemberDataTable

/Services.svc/Categories/{categoryNameOrId}/Contacts/UnsubRange

GET
Description: List all contacts for a category unsubscribed within the given timeframe.

Parameters:
Name	Type	Description
categoryNameOrId	String	The category name or category id.
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
CategoryMemberDataset.CategoryMemberDataTable

/Services.svc/Contacts

GET
Description: Load a set of contacts by their contactIDs or email address.

Parameters:
Name	Type	Description
emailaddrs	Array of String	Array of Email addresses to search for.
contactids	Array of Int32	Array of ContactIDs to search for.
Expand Parameters:
expand	String	(Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response.
SmsPrograms	SmsProgramMapDataset.SmsProgramMapDataTable
Return Value:
Type	Description
MemberDataset.MemberDataTable

POST: JSON
Description: Add new contacts. When batching multiple contacts, limit batch size to 100 or fewer.

Parameters:
Name	Type	Description
behavior	String	Behavior to apply when modifying contacts ADD -> Add missing contacts, error on existing contacts. UPDATE -> Ignore missing contacts, update existing contacts. UPSERT -> Add missing contacts, update existing contacts. UPSERTUSERID -> Perform an upsert operation, using the UserID as a key to allow email address changes. (UserID is required) UPDATECONTACTID -> Perform an update operation, using the ContactID as a key to allow email address changes. (ContactID is required) (default: UPSERT)
contacts	MemberDataset.MemberDataTable	List of contacts and demographic information to add.
categoryIDs	Array of Int32	Array of CategoryIDs to add the affected contacts to.
SmsPrograms	Array of String	Sms programs to subscribe mobile contacts to.
Return Value:
Type	Description
MemberDataset.MemberDataTable	See additional documentation.

/Services.svc/Contacts/{emailOrId}

GET
Description: Load a contact by their contactID or email address.

Parameters:
Name	Type	Description
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
Return Value:
Type	Description
MemberDataset.MemberDataTable

DELETE: JSON
Description: Delete a contact by their contactID or email address.

Parameters:
Name	Type	Description
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
removePermanently	Boolean	Whether to remove the contact permanently (true), or to unsubscribe the contact (false). (default: false)
Return Value:
Type	Description
Boolean

/Services.svc/Contacts/{emailOrId}/AddBanned

PUT: JSON
Description: Add an email to the banned addresses for an account or site.

Parameters:
Name	Type	Description
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
siteBan	Boolean	Whether to only ban in current account or entire site. (default false)
Return Value:
Type	Description
BannedMemberDataset.BannedMemberDataTable

/Services.svc/Contacts/{emailOrId}/Categories

GET
Description: Load all categories associated with the given contact.

Parameters:
Name	Type	Description
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
isSubscribed	Boolean	Whether to only return categories which the contact is currently subscribed to. (default true)
Return Value:
Type	Description
CategoryDataset.CategoryDataTable

POST: JSON
Description: Add a contact to a set of categories.

Parameters:
Name	Type	Description
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
categoryIDs	Array of Int32	Array of CategoryIDs to subscribe the contact to.
Return Value:
Type	Description
CategoryMemberDataset.CategoryMemberDataTable

/Services.svc/Contacts/{emailOrId}/Categories/{categoryNameOrId}

GET
Description: Load the category subscription information for a given contact and category.

Parameters:
Name	Type	Description
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
categoryNameOrId	String	The category name or category id.
Return Value:
Type	Description
CategoryMemberDataset.CategoryMemberDataTable

PUT
Description: Add a contact to a specific category.

Parameters:
Name	Type	Description
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
categoryNameOrId	String	The category name or category id.
Return Value:
Type	Description
Boolean

DELETE
Description: Remove a contact from a category.

Parameters:
Name	Type	Description
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
categoryNameOrId	String	The category name or category id.
Return Value:
Type	Description
Boolean

/Services.svc/Contacts/{emailOrId}/IsBanned

GET
Description: Check if a contact is listed as banned in the database.

Parameters:
Name	Type	Description
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
Return Value:
Type	Description
Boolean

/Services.svc/Contacts/Categories

GET
Description: Load all categories associated with the given contacts. NOTE: The list of contacts within each category is appended to the return value as ContactIDs.

Parameters:
Name	Type	Description
isSubscribed	Boolean	Whether to only return categories which the contacts are currently subscribed to. (default true)
contactIDs	Array of Int32	List of contacts to use to determine subscribed-to categories.
Return Value:
Type	Description
CategoryDataset.CategoryDataTable

/Services.svc/Contacts/ContactCountByStatus

GET
Description: Count total number of contacts by Contact Status.

Parameters:
none
Return Value:
Type	Description
MemberTypeCountDataset.MemberTypeCountDataTable

/Services.svc/Contacts/CustomTables

GET
Description: Load custom tables available to import contact data.

Parameters:
none
Return Value:
Type	Description
ExtendedDemographicsDataset.ExtendedDemographicTablesDataTable

/Services.svc/Contacts/CustomTables/{tableName}

POST: JSON
Description: Add/update rows for a specific table name. When batching for multiple contacts, limit batch size to 100 or fewer.

Parameters:
Name	Type	Description
tableName	String	Custom Table name.
rows	DataTable	Custom Table rows. See additional documentation.
Return Value:
Type	Description
DataTable	See additional documentation.

GET
Description: Load all records in a custom table for the current account.

Parameters:
Name	Type	Description
tableName	String	Custom Table name.
query	Query	(Optional) Query for records to return. See additional documentation. When specified, all primary key fields must be included.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
DataTable

DELETE: JSON
Description: Delete a record in a custom table.

Parameters:
Name	Type	Description
tableName	String	Custom Table name.
query	Query	Query for record to delete. See additional documentation. All primary key fields must be specified.
Return Value:
Type	Description
DataTable	The record that was deleted.

/Services.svc/Contacts/CustomTables/{tableName}/Contacts/{emailOrId}

GET
Description: Load records in a custom table for a contact.

Parameters:
Name	Type	Description
tableName	String	Custom Table name.
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
query	Query	(Optional) Query for records to return. See additional documentation.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
DataTable

DELETE: JSON
Description: Delete a record in a custom table for a contact.

Parameters:
Name	Type	Description
tableName	String	Custom Table name.
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
query	Query	Query for record to delete. See additional documentation. All primary key fields must be specified.
Return Value:
Type	Description
DataTable	The record that was deleted.

/Services.svc/Contacts/CustomTables/Schema/{tableName}

GET
Description: Load the custom table schema for a specific table name.

Parameters:
Name	Type	Description
tableName	String	Custom Table name.
Return Value:
Type	Description
SchemaTableDataset.SchemaTableDataTable

/Services.svc/Contacts/DemographicInfo

GET
Description: Load contact demographics information (including Demographic - column name, Alias - column alias, and PickList - list of valid column values [only if present]).

Parameters:
none
Expand Parameters:
expand	String	(Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response.
PickListValues	MemberDemographicInfoDataset.PickListValuesDataTable
Return Value:
Type	Description
MemberDemographicInfoDataset.MemberDemographicInfoDataTable

/Services.svc/Contacts/DemographicInfoPicklists

GET
Description: Load contact demographics (picklists only) information (including Demographic - column name, Alias - column alias, and PickList - list of valid column values).

Parameters:
none
Expand Parameters:
expand	String	(Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response.
PickListValues	MemberDemographicInfoDataset.PickListValuesDataTable
Return Value:
Type	Description
MemberDemographicInfoDataset.MemberDemographicInfoDataTable

/Services.svc/Contacts/DemographicInfoPicklistValues/{demographic}

GET
Description: Load contact demographics picklist values for a specific Demographic - column name.

Parameters:
Name	Type	Description
demographic	String	Picklist Demographic.
Return Value:
Type	Description
MemberDemographicInfoDataset.MemberDemographicInfoPicklistValuesDataTable

/Services.svc/Contacts/HeldRange

GET
Description: Load a set of contacts held within the given timeframe.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
MemberDataset.MemberDataTable

/Services.svc/Contacts/JoinRange

GET
Description: Load a set of contacts added within the given timeframe.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
MemberDataset.MemberDataTable

/Services.svc/Contacts/ListModified

GET
Description: Load a set of contacts recently modified since the given start date.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
MemberDataset.MemberDataTable

/Services.svc/Contacts/SmsPrograms

GET
Description: Load existing sms programs for this account.

Parameters:
none
Return Value:
Type	Description
SmsProgramDataset.SmsProgramDataTable

/Services.svc/Contacts/Test

GET
Description: Test the authentication credentials the user provided.

Parameters:
none
Return Value:
Type	Description
Int32

/Services.svc/Contacts/UnsubRange

GET
Description: Load a set of contacts unsubscribed within the given timeframe.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
MemberDataset.MemberDataTable

/Services.svc/ListNames

GET
Description: Load valid accounts for the logged in user.

Parameters:
none
Return Value:
Type	Description
ListDataset.ListDataTable

/Services.svc/Mailings/Approval

GET
Description: List mailings that need approval.

Parameters:
none
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Expand Parameters:
expand	String	(Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response.
Segments	ApprovalMailDataset.ApprovalMailSegmentsDataTable
Return Value:
Type	Description
ApprovalMailDataset.ApprovalMailDataTable

POST: JSON
Description: Add new mailings to the approval queue.

Parameters:
Name	Type	Description
newMail	MailDataset.MailDataTable	List of mailings to be created.
Return Value:
Type	Description
MailDataset.MailDataTable	See additional documentation.

/Services.svc/Mailings/Approval/{messageID}

GET
Description: Load an existing mailing.

Parameters:
Name	Type	Description
messageID	Int32	The MessageID of an existing mailing in the approval queue.
Expand Parameters:
expand	String	(Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response.
Segments	ApprovalMailDataset.ApprovalMailSegmentsDataTable
Return Value:
Type	Description
ApprovalMailDataset.ApprovalMailDataTable

DELETE
Description: Delete an existing mailing.

Parameters:
Name	Type	Description
messageID	Int32	The MessageID of an existing mailing in the approval queue.
Return Value:
Type	Description
Boolean

/Services.svc/Mailings/Scheduled

GET
Description: List mailings that are scheduled to send at a later date.

Parameters:
none
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Expand Parameters:
expand	String	(Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response.
Segments	ApprovalMailDataset.ApprovalMailSegmentsDataTable
Return Value:
Type	Description
ApprovalMailDataset.ApprovalMailDataTable

POST: JSON
Description: Add a new mailing to send later.

Parameters:
Name	Type	Description
newMail	MailDataset.MailDataTable	List of mailings to be created.
sendDateTime	DateTime	Schedule date/time for the mailings to be sent.
Return Value:
Type	Description
MailDataset.MailDataTable	See additional documentation.

/Services.svc/Mailings/Scheduled/{messageID}

PUT: JSON
Description: Schedule an existing mailing to send at a later date.

Parameters:
Name	Type	Description
messageID	Int32	The MessageID of an existing mailing in the approval or scheduled queue.
sendDateTime	DateTime	Schedule date/time for the mailings to be sent.
Return Value:
Type	Description
Boolean

DELETE
Description: Delete an existing mailing.

Parameters:
Name	Type	Description
messageID	Int32	The MessageID of an existing mailing in the scheduled queue.
Return Value:
Type	Description
Boolean

/Services.svc/Mailings/Scheduled/TimeOptimize/{messageID}

PUT: JSON
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	The MessageID of an existing mailing in the approval or scheduled queue.
sendDateTime	DateTime	Schedule date/time for the mailings to be sent.
Return Value:
Type	Description
Boolean

/Services.svc/Mailings/Scheduled/TimeZone/{messageID}

PUT: JSON
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	The MessageID of an existing mailing in the approval or scheduled queue.
sendDateTime	DateTime	Schedule date/time for the mailings to be sent.
Return Value:
Type	Description
Boolean

/Services.svc/Mailings/Sent

GET
Description: List mailings that have been sent.

Parameters:
Name	Type	Description
startDate	DateTime
endDate	DateTime
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
SentMailDataset.SentMailDataTable

/Services.svc/Mailings/SentSummary

GET
Description: Return a summary of all mailings and their completion status in a given date range.

Parameters:
Name	Type	Description
startDate	DateTime
endDate	DateTime
Paging Parameters:
pageSize	Int32	(Optional) The requested page size. Maximum of 10000.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
MailingStatisticsDataset.SentMailingSummaryDataTable

/Services.svc/Mailings/Tests/{messageID}

PUT: JSON
Description: Send a test mailing to a recipient.

Parameters:
Name	Type	Description
messageID	Int32	The MessageID of the mailing to be tested. May be a mailing in the approval or scheduled queues, or a transactional mailing.
sendSpamTest	Boolean	Whether to generate a spam test report in addition to the test mailing. (default: false)
toAddress	String	The address to send the test.
Return Value:
Type	Description
Int32	The MessageID for the new test mailing.

/Services.svc/Mailings/Transactional

GET
Description: List all automated and transactional mailings for this list.

Parameters:
none
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ApprovalMailDataset.ApprovalMailDataTable

POST: JSON
Description: Add new automated or transactional mailings.

Parameters:
Name	Type	Description
newMail	MailDataset.MailDataTable	List of mailings to be created.
mailingType	String	The type of the mailing, either automated or transactional.
Return Value:
Type	Description
MailDataset.MailDataTable	See additional documentation.

/Services.svc/Mailings/Transactional/{messageID}

GET
Description: Load record for the given TransactionalMessageID.

Parameters:
Name	Type	Description
messageID	Int32	The MessageID of an existing automated or transactional mailing.
Return Value:
Type	Description
ApprovalMailDataset.ApprovalMailDataTable

DELETE
Description: Delete an automated or transactional mailing.

Parameters:
Name	Type	Description
messageID	Int32	The MessageID of an existing mailing in the scheduled queue.
Return Value:
Type	Description
Boolean

/Services.svc/Mailings/Transactional/{messageID}/Recipients

POST: JSON
Description: Add a list of addresses to an automated or transactional mailing. Will add specified contacts to the list first if they do no exist.

Parameters:
Name	Type	Description
messageID	Int32	The MessageID of an existing automated or transactional mailing.
contacts	MemberDataset.MemberDataTable	List of contacts and demographic information to add.
Return Value:
Type	Description
Int32	The current outgoing MessageID for the specified automated or transactional mailing. Useful for querying reports.

/Services.svc/Mailings/Transactional/{messageID}/Recipients/{emailOrId}

PUT: JSON
Description: Add a contact to a automated or transactional mailing.

Parameters:
Name	Type	Description
messageID	Int32	The MessageID of an existing automated or transactional mailing.
emailOrId	String	The email address, ContactID, or phone number of an existing contact.
query	Query	(Optional) Query for records to mail merge. See additional documentation. Note: a query returning 0 records will result in the recipient being mailmerge aborted and not sent to.
Return Value:
Type	Description
Int32	The current outgoing MessageID for the specified transactional mailing. Useful for querying reports.

/Services.svc/Reports

GET
Description: List all reporting statistics for a given date range.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Expand Parameters:
expand	String	(Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response.
Segment	SegmentDataset.SegmentDataTable
DripCampaign	DripCampaignsDataset.DripCampaignsDataTable
SplitTest	SplitTestDataset.SplitTestsDataTable
Return Value:
Type	Description
ReportSummaryDataDataset.ReportSummaryDataDataTable

/Services.svc/Reports/{mailingID}

GET
Description: List all reporting statistics for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Expand Parameters:
expand	String	(Optional) A comma-delimited list of associated tables. Specify any of the properties below to include them in the response.
Segment	SegmentDataset.SegmentDataTable
DripCampaign	DripCampaignsDataset.DripCampaignsDataTable
SplitTest	SplitTestDataset.SplitTestsDataTable
Return Value:
Type	Description
ReportSummaryDataDataset.ReportSummaryDataDataTable

/Services.svc/Reports/{mailingID}/Bounces

GET
Description: List all Bounce events for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportBounceEventDataTable

/Services.svc/Reports/{mailingID}/Clickstream

GET
Description: List all Clickstream events for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportClickstreamEventDataTable

/Services.svc/Reports/{mailingID}/Clickthroughs

GET
Description: List all Clickthrough events with URL Name for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportNamedClickthroughEventDataTable

/Services.svc/Reports/{mailingID}/FullOpens

GET
Description: List all Open events with full details for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportOpenEventDataTable

/Services.svc/Reports/{mailingID}/Opens

GET
Description: List all Open events with basic details for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportEventDataTable

/Services.svc/Reports/{mailingID}/Purchase

GET
Description: List all Purchase events for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportPurchaseEventDataTable

/Services.svc/Reports/{mailingID}/Sends

GET
Description: List all Sent events for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportEventDataTable

/Services.svc/Reports/{mailingID}/Successes

GET
Description: List all Success events for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportEventDataTable

/Services.svc/Reports/{mailingID}/Unsubscribes

GET
Description: List all Unsubscribe events for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportEventDataTable

/Services.svc/Reports/Bounces

GET
Description: List all Bounce events within the given timeframe for this account.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportBounceEventDataTable

/Services.svc/Reports/Clickstream

GET
Description: List all Clickstream events within the given timeframe for this account.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportClickstreamEventDataTable

/Services.svc/Reports/Clickthroughs

GET
Description: List all Clickthrough events with URL Name within the given timeframe for this account.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportNamedClickthroughEventDataTable

/Services.svc/Reports/Fullopens

GET
Description: List all Open events with full details within the given timeframe for this account.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportOpenEventDataTable

/Services.svc/Reports/Opens

GET
Description: List all Open events with basic details within the given timeframe for this account.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportEventDataTable

/Services.svc/Reports/Purchase

GET
Description: List all Purchase events within the given timeframe for this account.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportPurchaseEventDataTable

/Services.svc/Reports/Sends

GET
Description: List all Sent events within the given timeframe for this account.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportEventDataTable

/Services.svc/Reports/SMSTrackingStat

GET
Description: List all SMS Tracking statistics for a given date range.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
SMSReportsTrackingStatDataset.SMSReportsTrackingStatDataTable

/Services.svc/Reports/SMSTrackingStat/{mailingID}

GET
Description: List all SMS Tracking statistics for a given MailingID.

Parameters:
Name	Type	Description
mailingID	Int32	The outgoing MessageID for a mailing that has already been sent.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
SMSReportsTrackingStatDataset.SMSReportsTrackingStatDataTable

/Services.svc/Reports/SubscriberActivity

GET
Description: List contact activity statistics for a date range.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Return Value:
Type	Description
MemberStatisticsDataset.SubscriberActivityDataTable

/Services.svc/Reports/Successes

GET
Description: List all Success events within the given timeframe for this account.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportEventDataTable

/Services.svc/Reports/Unsubscribes

GET
Description: List all Unsubscribe events within the given timeframe for this account.

Parameters:
Name	Type	Description
startDate	DateTime	Start of the reporting timeframe.
endDate	DateTime	End of the reporting timeframe.
Paging Parameters:
pageSize	Int32	(Optional) The requested page size.
pageNumber	Int32	(Optional) The page number to retrieve.
Return Value:
Type	Description
ReportEventDataset.ReportEventDataTable

/Services.svc/Roles

GET
Description: List Roles for the current account's site.

Parameters:
none
Return Value:
Type	Description
RoleDataset.RoleDataTable

/Services.svc/Segments

GET
Description: List segments for current account.

Parameters:
none
Return Value:
Type	Description
SegmentDataset.SegmentDataTable

/Services.svc/Segments/{segmentNameOrId}

GET
Description: Load a segment by its id or name.

Parameters:
Name	Type	Description
segmentNameOrId	String	The segment name or id.
Return Value:
Type	Description
SegmentDataset.SegmentDataTable

/Services.svc/Users/{siteName}/{newSiteAdminEmail}

PUT: JSON
Description: Create a new site admin for a given site.

Parameters:
Name	Type	Description
siteName	String	The Site Name to add the Site Admin.
newSiteAdminEmail	String	The Site Admin email address.
newSiteAdminName	String	The Site Admin full name.
Return Value:
Type	Description
void

/Services.svc/Webhooks

GET
Description: List Webhooks for the current account.

Parameters:
none
Return Value:
Type	Description
WebhookDefinitionDataset.WebhookDefinitionDataTable

POST: JSON
Description: Add or update webhooks based on the name.

Parameters:
Name	Type	Description
webhooks	WebhookDefinitionDataset.WebhookDefinitionDataTable
Return Value:
Type	Description
WebhookDefinitionDataset.WebhookDefinitionDataTable	See additional documentation.

/Services.svc/Webhooks/{webhookNameOrId}

GET
Description: Load a webhook by its id or name.

Parameters:
Name	Type	Description
webhookNameOrId	String
Return Value:
Type	Description
WebhookDefinitionDataset.WebhookDefinitionDataTable

DELETE
Description: Delete a webhook by its id or name.

Parameters:
Name	Type	Description
webhookNameOrId	String
Return Value:
Type	Description
void

Authentication

Available Routes

/Services.svc/Account/FooterHTML

/Services.svc/Categories