Docmail API Integration

Do you need a Docmail API integration solution that integrates Docmail’s fulfilment service with your accounting, ERP or CRM solution to automate the creation and distribution of direct mail?

Codeless Platforms' Docmail API integration Connector enables organisations to dynamically create and distribute direct mail communications through an intuitive drag and drop, point and click interface.

Download Brochure

Docmail API Integration Scenarios and Benefits

Common Docmail API integration scenarios requested by our customers using our Docmail Integration connector include:

  • Automate the creation and delivery of direct mail campaigns
  • Dynamically create and send print communications based on data events in your business software
  • Automate the creation and delivery of an associated email marketing or SMS messaging campaign every time a direct mail communication is run
  • Automate the creation and delivery of upsell/cross sell direct mail campaigns based on CRM data events e.g. contract renewal dates

Common benefits achieved through Docmail Integration include:

  • Reduced administrative costs associated with direct mail fulfilment
  • Removal of error prone administration tasks
  • Simplified communication processes
  • Integrated direct mail, email and SMS campaigns
See BPA Platform in action. Download Brochure

Docmail API Integration starts from...

Connector Pricing

Docmail

One time purchase

$665

BPA Server

Standard Product Base Server

Starts from:

$2,527

Docmail API Documentation

View the Docmail API Objects and Functions exposed by our Connector

Creating Mailings

The reference calls in this section can be used to create a mailing and set the mailing options within Docmail.

Add

  • Add Delivery Address
  • Add Mailing Filter

Create

  • Create File Mailing
  • Create Mailing

Update

  • Update Mailing Options

Mail Packs

The referenced calls in this section can be used to add mail pack data to a mailing.

Add

  • Add Designer Image
  • Add Designer Stored Image
  • Add Designer Template
  • Add Designer Text
  • Add Mail Pack From Library
  • Add Mail Pack From Order
  • Add Template Background File
  • Add Template Background Rule
  • Add Template File
  • Add Template From Library
  • Add Template From Order
  • Add Template Use Rule

Get

  • Get Template Image

Other

  • Data Intelligence

set

  • set Mail Pack Variable Value
  • set Template Variable Value

Mailing Lists

The referenced calls in this section can be used to add addresses to a mailing.

Add

  • Add Address
  • Add Mailing List File
  • Add Mailing List From Library
  • Add Mailing List From Order
  • Add Mailing List String
  • Add Self
  • Auto Correct Addresses

set

  • set Mailing List Proof Option

Delete and Cancel

The referenced calls in this section can be used to delete a mailing delete data from a mailing or cancel a mailing.

Cancel

  • Cancel Mailing
  • Cancel Mailing Approval

Delete

  • Delete Mail Pack
  • Delete Mailing
  • Delete Mailing List
  • Delete Template

Get

  • Get Balance
  • Get Mailing Details
  • Get Mailing GUID From Order Ref
  • Get Proof File
  • Get Proof Image
  • Get Status

Other

  • User Approve Mailing

Process

  • Process Mailing

Payment

The referenced calls in this section can be used to manage the processing payment and proof approval.

Cancel

  • Cancel Mailing
  • Cancel Mailing Approval

Delete

  • Delete Mail Pack
  • Delete Mailing
  • Delete Mailing List
  • Delete Template

Get

  • Get Balance
  • Get Mailing Details
  • Get Mailing GUID From Order Ref
  • Get Proof File
  • Get Proof Image
  • Get Status

Other

  • User Approve Mailing

Process

  • Process Mailing

Lists

The referenced calls in this section can be used to obtain lists of data.

List

  • List Document Types
  • List Formats
  • List Library Backgrounds
  • List Library Backgrounds Page Count
  • List Library Mail Packs
  • List Library Mail Packs Page Count
  • List Library Mailing Lists
  • List Library Mailing Lists Page Count
  • List Library Templates
  • List Library Templates Page Count
  • List Mailing Filter Categories
  • List Mailing Filters For Category
  • List Mailing Variable Values
  • List Mailings
  • List Mailings Page Count
  • List Product Types
  • List Template Variables

Zip Data

The referenced calls in this section can be used to download a zip file of the mail pack or mailing list data.

Add

  • Add User
  • Add User Organisation Structure Link
  • Add User Sign-up Data

Create

  • Create Account

Get

  • Get Mail Pack Zip
  • Get Mailing List Zip

Mailing List Address Counts and Price Estimates

The referenced calls in this section are designed to obtain price estimates. The address count calls can be used to obtain counts of addresses that can then be passed to the price estimate call.

Add

  • Add Mailing List File For Address Count
  • Add Mailing List String For Address Count
  • Poll Mailing List For Address Count

Get

  • Get Mailing Price Estimate
  • Get Price Estimate

Adding Library Data

The referenced calls in this section can be used to add data to the Library in Docmail.

Add

  • Add Background File To Library
  • Add Mail Pack To Library
  • Add Mailing List File To Library
  • Add Mailing List String To Library
  • Add Template File To Library
  • Add Template To Library Mail Pack

Extended Calls

This section is for calling additional functionality that was not available at the time the API was published. This functionality may be made available as standard calls in future versions of the API.

Extend

  • Extended Call
  • Extended Call Definition
  • Extended Call Methods
Data Integration & Synchronisation

Data Integration & Synchronisation

Integrate applications, systems and web services via easy-to-use, graphical tools.

Learn more about Data Integration & Synchronisation connectors

Drag and drop experience

A full drag and drop user experience so integration steps are visually represented within a wider automated process.

Transformation functions

A set of transform functions that can be dragged onto the mapping area to change the data between input and output.

Hundreds of connectors

Access hundreds of data connectors via one easy-to-use platform.
View Capability

Got a question?

Send us your questions and we will provide you with the information and resources that you need.

Enquire now

You don’t learn everything in life by reading a manual, sometimes it helps to get in touch

Phone: +44(0) 330 99 88 700