DMWS
The following operations are supported. For a formal definition, please review the Service Description.
-
AddAddress
Add an address. -
AddBackgroundFileToLibrary
Add a background file to the library. Overwrites the existing background if it already exists. -
AddDeliveryAddress
Add a delivery address. For use with courier delivery mailings only. -
AddDesignerImage
Add a designer image. -
AddDesignerStoredImage
Add designer stored image. -
AddDesignerTemplate
Add a designer template. -
AddDesignerText
Add designer text. -
AddMailPackFromLibrary
Add mail pack from library. -
AddMailPackFromOrder
Add a mail pack from a previous order. -
AddMailPackToLibrary
Add a mail pack to the library, will return the existing mail pack if already exists. -
AddMailingFilter
Add a mailing filter. For use by corporate accounts only. -
AddMailingListFile
Add a mailing list file. -
AddMailingListFileForAddressCount
Save a temporary mailing list file to obtaining address counts. Returns MailingListGUID that can be passed to PollMailingListAddressCounts to get the address counts. -
AddMailingListFileToLibrary
Save a mailing list file to a library mailing list, creating the mailing list if it does not already exists. Returns MailingListGUID that can be passed to PollMailingListAddressCounts to get the address counts. -
AddMailingListFromLibrary
Add a mailing list from the library. -
AddMailingListFromOrder
Add a mailing list from a previous order. -
AddMailingListString
Add a mailing list string. -
AddMailingListStringForAddressCount
Save a temporary mailing list from a string to obtaining address counts. Returns MailingListGUID that can be passed to PollMailingListAddressCounts to get the address counts. -
AddMailingListStringToLibrary
Save a mailing list from a string to a library mailing list, creating the mailing list if it does not already exists. Returns MailingListGUID that can be passed to PollMailingListAddressCounts to get the address counts. -
AddSelf
Add self to the mailing. -
AddTemplateBackgroundFile
Add background file to a template. -
AddTemplateBackgroundRule
Add a template background rule. -
AddTemplateFile
Add a template file to a mailing. -
AddTemplateFileToLibrary
Add a template file to the library. This can be used on an order by calling AddTemplateFromLibrary. -
AddTemplateFromLibrary
Add a template from the library. -
AddTemplateFromOrder
Add a template from a previous order. -
AddTemplateToLibraryMailPack
Add a template to a library mail pack. -
AddTemplateUseRule
Add a template use rule. -
AddUser
Add a user to your account. -
AddUserOrganisationStructureLink
Link a user to an organisational structure. For use by corporate accounts only. -
AddUserSignupData
Add custom signup data for the user. For use by corporate accounts only. -
AutoCorrectAddresses
Auto correct all the addresses added to the mailing. -
CancelMailing
Cancel a mailing. -
CancelMailingApproval
User approve the mailing, optionally auto submitting the mailing. -
CreateAccount
Create an Account. Please contact the support team to obtain permission to use this function. -
CreateFileMailing
Create mailings from a zip file. Include an XML file to control the mailings referencing DMWS.xsd for the schema information. -
CreateMailing
Create a mailing. -
DeleteMailPack
Delete the mail pack from a mailing. -
DeleteMailing
Delete a mailing. -
DeleteMailingList
Delete the mailing list from a mailing. -
DeleteTemplate
Delete a template from a mailing. -
ExtendedCall
Call an extended method. -
ExtendedCallDefinition
Get the definition for an extended method. -
GetBalance
Get the current account balance. -
GetMailPackZip
Get the mail pack templates in a zip file. -
GetMailingDetails
Get details of the mailing. -
GetMailingGUIDFromOrderRef
Get the Mailing GUID from the Order Ref. -
GetMailingListZip
Get the mailing list in a zip file. Only returns data once the mailing has been submitted. -
GetMailingPriceEstimate
Get price estimate for a mailing. -
GetPriceEstimate
Get price estimate for specified data. -
GetProofFile
Get the mailing PDF proof file. -
GetProofImage
Get the mailing proof image for a given page. Supply 0 for the page to get an index image. -
GetStatus
Get the current status of the auto mailing process. -
GetTemplateImage
Get the template preview image. Supply 0 for the page to get an index image. -
ListDocumentTypes
Get a list of document types for a product type. -
ListLibraryBackgrounds
Get a list of library backgrounds. -
ListLibraryBackgroundsPageCount
Get the count of pages for a list of library backgrounds. -
ListLibraryMailPacks
Get a list of library mail packs. -
ListLibraryMailPacksPageCount
Get the count of pages for a list of library mail packs. -
ListLibraryMailingLists
Get a list of library mailing lists. -
ListLibraryMailingListsPageCount
Get the count of pages for a list of library mailing lists. -
ListLibraryTemplates
Get a list of library templates or inserts. -
ListLibraryTemplatesPageCount
Get the count of pages for a list of library templates or inserts. -
ListMailingFilterCategories
Get a list of mailing filter categories. For use by corporate accounts only. -
ListMailingFiltersForCategory
Get a list of mailing filter values for a given category. For use by corporate accounts only. -
ListMailingVariableValues
Get a list of template variable values. For use by corporate accounts only. -
ListMailings
Get a list of mailings. -
ListMailingsPageCount
Get the count of pages for a list of mailings. -
ListProductTypes
Get a list of product types. -
ListTemplateVariables
Get a list of template variables for a given template. -
PollMailingListAddressCounts
Get the address counts for a mailing list. The address counts returned can be passed to GetPriceEstimate to calculate an estimated price. -
ProcessMailing
Flag the mailing as ready to process. -
SetMailPackVariableValue
Set a variable value for all templates containing the variable in the mail pack. -
SetMailingListProofOption
Set the mailing list proof option. -
SetTemplateVariableValue
Set template variable value. -
UpdateMailingOptions
Update mailing options on an existing mailing. -
UserApproveMailing
User approve the mailing.