API Documentation

Overview

Heybox is a secure and reliable email delivery service that supports HMAC-SHA256 signature authentication to ensure the security and integrity of requests.

Authentication

Every API call requires an access token. Please include the following in your request header. If you don’t have a token yet, please log in to your account and create one in the API Keys page of the dashboard.

API Endpoints

Code Examples

curl -X POST https://api.heybox.io/v1/send \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "Authorization: Bearer <token>" \
  -d '{
    "from": "[email protected]",
    "to": "[email protected]",
    "subject": "test send",
    "body": "test content"
  }'

const response = await fetch('https://api.heybox.io/v1/send', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>'
  },
  body: JSON.stringify({
    from: '[email protected]',
    to: '[email protected]',
    subject: 'test send',
    body: 'test content'
  })
});

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

{
    "requestId":"7d7db227-4f67-4318-8231-480bf519db54",
    "code":0,
    "success":true,
    "message":"Successfully",
    "ts":1758864125072,
    "data":null
}

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of requests.