API docs by Redocly

Email Sending API (1.0.0)

Download OpenAPI specification:Download

This API allows you to send emails with attachments.

Authentication

The API uses Bearer Token authentication. You need to provide the token in the Authorization header for all requests. Example:

Authorization: Bearer YOUR_API_KEY

Send an email

Request Body schema:
required
from
required
string

The email address of the sender.

to
required
string

The email address of the recipient.

subject
required
string

The subject of the email.

text
required
string

The plain text content of the email.

html
required
string

The HTML content of the email.

headers
required
string

Custom headers as a JSON string.

attachments
required
Array of strings <binary> [ items <binary > ]

Files to be attached to the email.

Responses

Request samples

Content type
{
  "from": "sender@example.com",
  "to": "recipient@example.com",
  "subject": "Test Email",
  "text": "Hello, this is a test email!",
  "html": "<html><body><h1>Hello, this is a test email!</h1><p>Visit <a href='https://www.example.com'>Example</a> for more information.</p></body></html>",
  "headers": "{\"x-custom-header\": \"Custom header value\", \"x-var\": \"Unwanted header\"}",
  "attachments": [
    "file1.txt",
    "file2.txt"
  ]
}

Response samples

Content type
application/json
{
  • "message": "Email sent",
  • "info": {
    }
}

Get server status

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "message": "server is up"
}