Talk with founders
Developers

Overview

Get started with the Artmail API and integrate email sending into your applications

Welcome to the Artmail API

The Artmail API allows you to programmatically send transactional and marketing emails from your applications. Whether you're building a SaaS product, e-commerce platform, or any application that needs to send emails, our API provides a simple, reliable way to deliver messages to your users.

What You Can Do

With the Artmail API, you can:

Send Transactional Emails

Send password resets, order confirmations, notifications, and other transactional messages directly from your application.

Send Marketing Campaigns

Create and send marketing emails to your audience using templates or custom HTML.

Track Email Status

Monitor delivery status, opens, clicks, and bounces for all emails sent through the API.

Manage Templates

Create, update, and manage email templates programmatically.

Set Up Webhooks

Receive real-time notifications about email events like opens, clicks, bounces, and deliveries.

List and Query Emails

Retrieve information about emails you've sent, including status and analytics.

Base URL

All API requests should be made to:

https://api.artmail.io/v1

API Versioning

We use URL-based versioning. The current version is v1. Future versions will be available at /v2, /v3, etc.

Authentication

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

Authorization: Bearer art_live_your_api_key_here

Keep Your API Key Secret

Your API key provides full access to your Artmail account. Never share it publicly, commit it to version control, or expose it in client-side code.

Learn more about authentication →

Making Requests

The Artmail API follows RESTful conventions and uses standard HTTP methods:

  • GET - Retrieve resources
  • POST - Create resources or perform actions
  • PATCH - Update resources
  • DELETE - Delete resources

Request Format

All requests should include:

  • Content-Type: application/json (for POST/PATCH requests with a body)
  • Authorization: Bearer art_live_your_api_key_here

Response Format

All responses are returned as JSON with the following structure:

Success Response:

JSON
Loading...

Error Response:

JSON
Loading...

Rate Limits

API requests are subject to rate limits to ensure fair usage and system stability. Rate limits are applied per API key and can be configured in your dashboard.

Default limits:

  • Per Second: 10 requests
  • Per Day: 10,000 requests

Rate limit information is included in response headers:

  • X-RateLimit-Limit - Maximum requests allowed
  • X-RateLimit-Remaining - Requests remaining in the current window
  • X-RateLimit-Reset - Unix timestamp when the limit resets

Learn more about rate limits →

Error Handling

The API uses standard HTTP status codes to indicate success or failure:

  • 200 OK - Request succeeded
  • 201 Created - Resource created successfully
  • 400 Bad Request - Invalid request parameters
  • 401 Unauthorized - Missing or invalid API key
  • 403 Forbidden - Insufficient permissions
  • 404 Not Found - Resource not found
  • 429 Too Many Requests - Rate limit exceeded
  • 500 Internal Server Error - Server error

Learn more about error handling →

SDKs and Libraries

We provide official SDKs and code examples to help you get started quickly:

Our official Node.js SDK makes it easy to integrate Artmail into your Node.js applications.

Get the Node.js SDK →

Quick Start

Ready to send your first email? Follow these steps:

1

Get Your API Key

  1. Log in to your Artmail dashboard
  2. Navigate to Developers → API Keys
  3. Click Create API Key
  4. Copy your key (you'll only see it once!)

Create an API key →

2

Send Your First Email

Use the Send Email endpoint to send a transactional email:

Typescript
Loading...

Learn more about sending emails →

3

Check Email Status

Query the status of your sent email:

Typescript
Loading...

Learn more about email status →

Next Steps

Now that you understand the basics, explore these topics:

Authentication

Learn how to create and manage API keys, set permissions, and secure your integration.

Authentication guide →

Send Email

Discover how to send transactional and marketing emails with the API.

Send Email guide →

Webhooks

Set up webhooks to receive real-time notifications about email events.

Webhooks guide →

Error Handling

Understand error codes, retry strategies, and best practices for handling API errors.

Error Handling guide →

Need Help?

Our team is here to support you:

API Documentation

Browse the complete API reference for all endpoints and parameters.

Support Email

Contact us at api-support@artmail.com for API-specific questions.

Community

Join our developer community for tips, examples, and discussions.