API Operations
This table provides a quick reference of all API operations with their descriptions. Click the operation name to view the full details and code samples.
| Name | Description |
|---|---|
| AddAddress | This function adds an address to the mailing. To validate the address use the Process Mailing call after adding it. |
| AddBackgroundFileToLibrary | This call allows a background file to be added to the library, overwriting the existing background of the same name if it already exists. |
| AddCampaign | This call adds a Dotpost campaign. |
| AddDeliveryAddress | This call is for courier despatch orders only and adds a delivery address to the order. |
| AddDesignerImage | This call adds an image file to a designer template. |
| AddDesignerStoredImage | This call adds a stored image to a designer template. |
| AddDesignerTemplate | This call adds a designer template to the current mailing, allowing the creation of postcards, greeting cards or outer envelopes by uploading or selecting the parts that make up the final template.... |
| AddDesignerText | This call adds text to part of a designer template or to set the return address on an outer envelope. |
| AddLibraryTemplateBackgroundRule | This call adds a template background rule to a library mail pack. |
| AddMailingFilter | Adds a filter to the mailing to adjust how the mailing is processed. |
| AddMailingListFile | This function adds the addresses from a mailing list file to the mailing. This call returns a Mailing List GUID that can be used for obtaining address count information. To check if the import is c... |
| AddMailingListFileForAddressCount | This function adds the addresses from a mailing list file to a temporary mailing list. This call returns a Mailing List GUID that can be used for obtaining address count information. |
| AddMailingListFileToLibrary | This call is no longer supported; addresses should be added to each mailing. |
| AddMailingListFileWithPassword | This function adds the addresses from a mailing list file to the mailing, optionally supplying an encryption password. This call returns a Mailing List GUID that can be used for obtaining address c... |
| AddMailingListFileWithPasswordToLibrary | This call is no longer supported; addresses should be added to each mailing. |
| AddMailingListFromLibrary | This call is no longer supported; addresses should be added to each mailing. |
| AddMailingListFromOrder | This call is now obsolete; addresses should be added to each mailing. |
| AddMailingListString | This function starts a process of importing addresses from a formatted string to the mailing. This call returns a Mailing List GUID that can be used for obtaining address count information. To chec... |
| AddMailingListStringForAddressCount | This function adds the addresses from a formatted string to a temporary mailing list. This call returns a Mailing List GUID that can be used for obtaining address count information. |
| AddMailingListStringToLibrary | This call is no longer supported; addresses should be added to each mailing. |
| AddMailPackFromLibrary | This call adds a mail pack from the library. This call returns a mail pack GUID that can be used to set variable values along with TemplateGUID 1, TemplateGUID 2 etc for each template that has been... |
| AddMailPackFromOrder | This call is now obsolete; documents should be added to each mailing or mail packs added from the library.** |
| AddMailPackToLibrary | This call adds a mail pack to the library. Returns a mail pack GUID of either the existing mail pack with the name supplied or a newly created mail pack if the name does not exist. |
| AddSelf | This function adds the speficied user’s address to the mailing. |
| AddTemplateBackgroundFile | This call allows a background file to be added against a specific template on a mailing. |
| AddTemplateBackgroundRule | This call enables data intelligence on a mailing and adds a background rule against the specified template. |
| AddTemplateFile | This call adds a template document to the mailing. This call returns a template GUID that can be used to add a background file or variable values. |
| AddTemplateFileToLibrary | This call adds a template document to the library, overwriting the existing background of the same name if it already exists. |
| AddTemplateFromLibrary | This call adds a documents or outer envelopes from the library. This call returns a template GUID that can be used to add a background file or set variable values. For corporate users this call can... |
| AddTemplateFromOrder | This call is now obsolete; documents should be added to each mailing or added from the library.** |
| AddTemplateToLibraryMailPack | This call adds a library template to a library mail pack. |
| AddTemplateUseRule | This call enables data intelligence on a mailing and adds a template use rule. |
| AddUser | This call adds a user to your account. Note that calls that attempt to create users are restricted to a maximum of 10 per minute. |
| AddUserOrganisationStructureLink | This call is for corporate users only and links a user to the organisational structure. |
| AddUserSignupData | This call is for corporate users only and adds additional sign-up data for the user. |
| AgreeToTerms | This call sets the current user as agreeing to the terms of service and marketing preferences. |
| AutoCorrectAddresses | This function applies correction to the addresses after all the addresses have been added to the mailing. |
| CancelMailing | This call cancels a mailing. |
| CancelMailingApproval | This call cancels all approval on the mailing, allowing the mailing to be edited. |
| CanUseDotpost | This call returns various information relating to Dotpost settings on the account. |
| ContentApproveMailing | This call is for corporate users only and content approves or rejects a mailing. Please note that the mailing will be submitted if auto submit is enabled on the account, otherwise the PayMailing ex... |
| CreateAccount | This call creates a Docmail account. You must obtain permission from the Docmail support team to use this call. Note that calls that attempt to create users are restricted to a maximum of 10 per mi... |
| CreateFileMailing | This call allows one or more mailings to be created from a zip file without the need for any further calls. To control the mailings an XML configuration file needs to be included within the zip fil... |
| CreateMailing | This call adds a new mailing to the account using the parameters defined. This call returns a mailing GUID that can be used to add data to the mailing, and it also returns the order ref. |
| CreateZipMailing | This call allows one or more mailings to be created from a zip file without the need for any further calls. To control the mailings an XML configuration file needs to be included within the zip fil... |
| DeleteAddress | This call deletes the mailing address matching the supplied Customer Address ID. The Customer Address ID must be supplied in the address data and should be unique for each address on the mailing. I... |
| DeleteLibraryBackground | This call deletes a library background matching the supplied name. |
| DeleteLibraryMailPack | This call deletes the library mail pack accessible for the user matching the supplied name. |
| DeleteLibraryTemplate | This call deletes the library document or insert accessible for the user matching the supplied name. |
| DeleteLibraryTemplateFromLibraryMailPack | This call deletes a document from a library mail pack. |
| DeleteMailing | This call deletes a mailing. |
| DeleteMailingList | This call deletes all addresses from the mailing. |
| DeleteMailPack | This call deletes all templates from the mailing. |
| DeleteTemplate | This call deletes a template from the mailing. |
| ExtendedCall | This call is for calling an extended method. |
| ExtendedCallDefinition | Public Function ExtendedCallDefinition(ByVal Username As String, ByVal Password As String, ByVal MethodName As String, ByVal ReturnFormat As String) As String |
| GetBalance | This call gets the current balance for the given account type. Returns Current Balance for a top-up account, or Credit Limit, Credit Available and Amount owed for an invoice account. |
| GetClosedFaceEnvelopesImage | This call gets a PNG format sample preview image file for a closed face envelope. |
| GetDefaultMailingOptions | This call returns the default mailing options on the account for a given product. |
| GetLibraryBackgroundFile | Gets the file of the library background matching the supplied background name. |
| GetLibraryMailPackFile | Gets a zip file of mail pack matching the supplied mail pack name. |
| GetLibraryTemplateFile | Gets the file of the supplied template name. |
| GetMailingDetails | This call gets the details of the mailing. Please note that the status code changes to “Complete” once the mailing has been despatched. This information is only updated a few times a day, therefore... |
| GetMailingFile | Gets a zip file of the mailing, including the documents, address data, proof files and an XML control file. |
| GetMailingGUIDFromOrderRef | This call gets the mailing GUID for a given order reference. |
| GetMailingListZip | This call provides a zip archive file containing a CSV file of the addresses on a mailing. |
| GetMailingPriceEstimate | This function gets a price estimate for a mailing given a total number of expected printed sides. |
| GetMailPackZip | This call provides all the templates from a mail pack in a zip archive file. |
| GetPriceEstimate | This function gets a price estimate for a given set of parameters. |
| GetPriceEstimateWithReturns | This call returns a price estimate including the cost of returns managements. |
| GetProcessingError | This call returns details of any errors from processing the mailing. |
| GetProofFile | This call gets the PDF proof file for the mailing. Before using this call the mailing must have been fully processed by calling Process Mailing, otherwise a failure will be returned. |
| GetProofImage | This call gets the PNG format proof image file for a given page. Proof images are limited to a maximum of 20 pages. The mailing must have been fully processed before using this call, otherwise a fa... |
| GetProofPackFile | This call gets the PDF proof file for the mailing via a pack number returned from the ListProofPackDetails call. Before using this call the mailing must have been fully processed by calling Process... |
| GetProofPackImage | This call gets the PNG format proof image file for a given pack number (returned from the ListProofPackDetails call) and page. Proof images are limited to a maximum of 20 pages. The mailing must ha... |
| GetReturnAddresses | This call requires no additional properties as the data returned is based upon the user name passed into the Extended Call. |
| GetStatus | This call gets the processing status of the mailing. This call can be polled at regular intervals to ascertain when the processing is complete. Fully processing a mailing including a proof takes a... |
| GetTemplateImage | This call returns a byte array image preview or thumbnail. Pass the page number as 0 for the thumbnail or 1 for the large preview image. |
| GetUserLoginKey | This call returns a pass key that can be used instead of a user password. It is recommended that a pass key is used for performance. If a key expires then a -130 error code will be returned from ... |
| GetZipStatus | This call returns the status of the zip file processing, along with “MailingGUID 1”, “MailingGUID 2” etc for each mailing in the XML file. |
| ListClosedFaceEnvelopes | This call returns a list of Outer Envelopes configured on the account. |
| ListDocumentTypes | This call returns a list of available document types for a given product type. |
| ListDotpostCampaigns | This call returns a list of Dotpost campaigns available for an account. |
| ListLibraryBackgrounds | This call retrieves a list of library backgrounds. |
| ListLibraryBackgroundsPageCount | This call retrieves the page count for a list of library backgrounds, returns a page count of zero if no backgrounds are found for the search criteria. |
| ListLibraryMailingLists | This call is no longer supported; addresses should be added to each mailing. |
| ListLibraryMailingListsPageCount | This call is no longer supported; addresses should be added to each mailing. |
| ListLibraryMailPacks | This call retrieves a list of library mail packs. |
| ListLibraryMailPacksPageCount | This call retrieves the page count for a list of library mail packs, returns a page count of zero if no mail packs are found for the search criteria. |
| ListLibraryTemplates | This call retrieves a list of library templates. |
| ListLibraryTemplatesPageCount | This call retrieves the page count for a list of library templates, returns a page count of zero if no templates are found for the search criteria. |
| ListMailingFilterCategories | This call is for corporate users only and returns a list of the mailing filter categories. |
| ListMailingFiltersForCategory | This call is for corporate users only and returns a list of mailing filter values for a given category. |
| ListMailingProcessingData | This call is now obsolete. |
| ListMailings | This call retrieves a list of mailings. |
| ListMailingsPageCount | This call retrieves the page count for a list of mailings, returns a page count of zero if no mailings are found for the search criteria. |
| ListMailingsWithDescription | This call returns a list of mailings including the mailing description. |
| ListMailingVariableValues | This call is no longer supported. |
| ListOrganisationStructureData | This call is for corporate users and returns a list of organisation structure data for a given category name. |
| ListProductTypes | This call returns a list of available product types. |
| ListProofPackDetails | This call returns a list of the proofs available. A proof per address and despatch type is returned if Dotpost or Per Address Proofs are enabled on the mailing. |
| ListReplyEnvelopes | This call returns a list of Reply Envelopes configured on the account. |
| ListReturns | This call returns a list of Returns on the account, ordered by the most recently recorded first. |
| ListTemplateVariables | This call returns a list of available template variables for a given template. Please note that before using this call for mailing templates a partial Process Mailingcall must be made to process th... |
| PayMailing | This call pays for a mailing if it is not automatically submitted from the Process Mailing call. |
| PollMailingListAddressCounts | This function polls the status of the address count. |
| ProcessMailing | This call runs the processing on the mailing and optionally submits a mailing for printing. If your mailing has already been processed and there are no changes then this call can be called again wi... |
| RefreshBudgetPeriods | This call is for corporate users only and updates the budget periods to the latest period if the mailing was created against a previous budget period. The account must use the budget approval metho... |
| RetrieveMailingFromArchive | This call is now obsolete. |
| SetDataIntelligence | This call sets the use data intelligence flag on a mailing. |
| SetDataIntelligenceDefaultTemplateRule | Sets the data intelligence default template rule and turns on data intelligence for the mailing if not already set. |
| SetErrorSimulation | This call sets an error code on the account that makes GetStatus return “Error in processing” and the GetProcessingError return the supplied error code. |
| SetMailingAPICancelOnly | This call sets whether the mailing can be cancelled from the API only. |
| SetMailingListProofOption | This function applies proof option to the addresses after all the addresses have been added to the mailing. |
| SetMailingReturnsManaged | This call sets the returns management option on a mailing. |
| SetMailPackVariableValue | This call sets a variable value for all templates containing the variable in the mail pack. Please note that this call does not check for a valid variable name as it occurs prior to scanning templa... |
| SetTemplateBackground | This call sets the template background to the specified library background. |
| SetTemplateVariableValue | This call sets a variable value on a specified template. Please note that this call does not check for a valid variable name as it occurs prior to scanning the template for variables. |
| TermsAgreementRequired | This call checks if terms of service agreement is required. Terms can be agreed by logging into the website or by calling AgreeToTerms |
| UpdateMailingOptions | This call updates the mailing options for a given mailing GUID. |
| UserApproveMailing | This call user approves the mailing. Please note that the mailing will be submitted if there is no further corporate approval required and auto submission is enabled on the account; otherwise the m... |