About the API

Mailcoach lets you perform multiple actions through a simple, structured application programming interface (API). Let’s help get you started.

On this page:

API Endpoints

All endpoints start with https://[[your-domain]].mailcoach.app/api. You will find a logical structure that follows the REST standard.

Here is a quick summary of the API methods.

  • GET: all GET requests are for data retrieval only and will never modify any data.
  • POST: a POST method will add new items to Mailcoach.
  • DELETE: the DELETE method is used to delete items.
  • PUT: this method is used to update information on existing items.

In general, GET requests can be performed as many times as you’d like (they are idempotent); all other methods actually transform data in your account and will cause changes to take effect.

Responses

All responses from the Mailcoach API will be formatted as JSON. Here is an example payload of the /api/templates endpoint that lists all templates.

{
  "data": [
    {
      "id": 1,
      "name": "Newsletter template",
      ...
    },
    {
      "id": 2,
      "name": "A second template",
      ...
    }
  ]
}
Using an SDK