return to Table of Contents, Version 1 API (Deprecated)


This page contains documentation for version 1 of our API, which is now deprecated. New projects should use version 2.

Direct Mail provides a RESTful API that allows clients of the API to insert, update, or remove addresses from a user's mailing list. The API is hosted at and is available regardless of whether the user has Direct Mail running at the time on his or her machine. Changes are synced to Direct Mail the next time the user opens his or her Project.

Since Direct Mail stores all Project data on the user's local machine and not in "the cloud", the API is unable to query the current state or contents of the user's mailing lists (i.e. the GET method is unsupported for all resources). However, the API is able to insert, update, or delete addresses via the PUT and DELETE HTTP verbs, with changes propagated to the user's Project the next time he or she opens Direct Mail.


The API will return a valid HTTP status code in response to each request. For error codes (400 and above), the body of the response will include a JSON dictionary with two keys:

  • code: The HTTP status code for the response is repeated here. This key is always present.
  • error_message: A human-readable description of the error. This key may not always be present.

Receiving a status code of 200 in the response does not necessarily mean the change has successfully been made to the user's Direct Mail Project, but rather that the change has been successfully queued and that it will be synced to the Project the next time the user opens Direct Mail. If the user has their Direct Mail Project open when the API call is made, they will see the changes applied in real time.

System Requirements

The user will need to be running Direct Mail 3.4 or newer in order to enable API access.

Getting Started

To get started, please read our guide on authorizing API access, then feel free to dive right in to the sample code we've provided. Please refer to the API table of contents for additional detail.

Did you find this article helpful? Yes | No