What is Mailercloud Email API?

The Mailercloud Email API allows you to send emails automatically from your application or website. You can define the sender, recipients, subject, email content, and even add attachments. This is useful for sending automated emails like order confirmations, password resets, or marketing emails.

How to Use the Email API?

To use this API, you need an API key for authentication.

API Endpoint

The API URL where you need to send the request:

POST https://email-api.mailercloud.com/email

Authentication

Include your API key in the request headers.

Content-Type: application/json
Authorization: Bearer YOUR_API_KEY

What Information is Required?

Example of Sending an Email Using API

{
    "email": {
        "from": "support@yourcompany.com",
        "fromName": "Your Company",
        "replyTo": ["noreply@yourcompany.com"],
        "subject": "Welcome to Our Platform!",
        "text": "Hello John, welcome to our platform!",
        "html": "<h1>Hello John,</h1><p>Welcome to our platform!</p>",
        "recipients": {
            "to": [{"name": "John Doe", "email": "johndoe@example.com"}]
        }
    }
}

Understanding API Responses

Once you send a request, you will receive a response:

• Success Response:

{
    "status": "success",
    "message_id": "xyz12345",
    "description": "Email sent successfully."
}

• Error Response (e.g., Invalid Email):

{
    "status": "error",
    "error_code": 400,
    "message": "Invalid email address format"
}

Status Codes and Their Meaning