API Documentation

Welcome to the QuickMailTo API documentation. This guide will help you integrate our email sending service into your application.

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

You can find your API key in the dashboard after signing in.

Base URL

All API endpoints are relative to the base URL:

https://api.quickmailto.com

Rate Limits

API requests are rate limited to protect the service. Current limits:

• 60 requests per minute per API key
• Burst limit: 10 requests

Rate limit headers are included in every response:

• X-RateLimit-Limit - Maximum requests per window
• X-RateLimit-Remaining - Remaining requests in current window
• X-RateLimit-Reset - Time when the rate limit resets

Send Message

Send an email message to one or more recipients.

Request Body

* At least one of text, html, or template_id is required.

Example Request

curl -X POST https://api.quickmailto.com/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "sender@example.com",
    "to": ["user@example.com"],
    "subject": "Hello from QuickMailTo",
    "text": "This is a test email.",
    "html": "<h1>Hello!</h1><p>This is a test email.</p>"
  }'

package main

import (
    "bytes"
    "encoding/json"
    "net/http"
)

func sendEmail() {
    payload := map[string]interface{}{
        "from":    "sender@example.com",
        "to":      []string{"user@example.com"},
        "subject": "Hello from QuickMailTo",
        "text":    "This is a test email.",
    }

    body, _ := json.Marshal(payload)
    req, _ := http.NewRequest("POST",
        "https://api.quickmailto.com/v1/messages",
        bytes.NewBuffer(body))

    req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, _ := client.Do(req)
    defer resp.Body.Close()
}

import requests

response = requests.post(
    "https://api.quickmailto.com/v1/messages",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
        "from": "sender@example.com",
        "to": ["user@example.com"],
        "subject": "Hello from QuickMailTo",
        "text": "This is a test email."
    }
)

print(response.json())

const response = await fetch('https://api.quickmailto.com/v1/messages', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    from: 'sender@example.com',
    to: ['user@example.com'],
    subject: 'Hello from QuickMailTo',
    text: 'This is a test email.'
  })
});

const data = await response.json();
console.log(data);

Response

{
  "success": true,
  "data": {
    "id": "msg_abc123",
    "message_id": "<abc123@quickmailto.com>",
    "status": "queued"
  }
}

List Messages

Retrieve a paginated list of sent messages.

Query Parameters

Get Message

Retrieve details of a specific message.

Create Template

Create a reusable email template with variable placeholders.

Request Body

List Templates

Get Template

Update Template

Delete Template

Create Webhook

Register a webhook endpoint to receive email events.

Request Body

List Webhooks

Get Webhook

Update Webhook

Delete Webhook

List Events

Retrieve a list of email events.

Query Parameters

Get Message Events

Retrieve all events for a specific message.

Error Codes

The API uses standard HTTP status codes and returns errors in a consistent format.

Error Response Format

{
  "success": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid email address format",
    "details": { ... }
  }
}

Event Types

The following event types can be tracked and delivered via webhooks: