API Introduction

All the information about the API endpoints, authentication and response

The Mailazy API is built on HTTP:

  • Uses resource-oriented URLs
  • Uses built-in HTTP capabilities for passing parameters and authentication.
  • Responds with standard HTTP response codes to indicate errors.
  • Returns JSON.

Prerequisites

Before you can start using the API, you need to do the following:

  1. Create a Mailazy account.
  2. Create an API Key and Secret.

Base URL

https://api.mailazy.com

Authentication

You authenticate to the Mailazy API by providing your API Key and Secret in the request. You can manage your access keys on the dashboard itself.

Authentication to the API can be done via HTTP Headers. Here is how you use basic HTTP auth with curl:

curl --header 'X-Api-Key: <Key>' \
     --header 'X-Api-Secret: <Secret>' \

Response Messages

All responses are returned in JSON format. We specify this by sending the Content-Type header.

Email Message Attachment

You can post multiple attachment values, You just need to add attachments array property on the request JSON object that can contain one or more attachments.

We allow a maximum of 10MB of attachment data including your HTML and Text content. You can only send following attachment types:

  • .pdf
  • .csv
  • .xlsx
  • .xls