Getting Started

Welcome to the Arsel Developer Documentation. This guide covers everything you need to integrate email and SMS messaging into your applications.

What You Can Do

The Arsel API provides two communication channels, each with full sending and tracking capabilities:

• Email — Send transactional emails with HTML, plain text, or pre-built templates. Track delivery, opens, clicks, bounces, and complaints per recipient.
• SMS — Send transactional SMS messages to KSA and Egypt phone numbers. Track delivery status per recipient.

You can also integrate via SMTP if your application already uses an SMTP client, letting you send emails without changing your existing email code.

Base URL

All API endpoints are relative to:

https://api.arsel.sa/v1

Authentication

Authenticate every request by including your API key in the Authorization header:

Authorization: Bearer be_your_api_key_here

API keys are generated from your Arsel Dashboard. See Authentication for details.

Quick Example

Send your first email in seconds:

curl -X POST "https://api.arsel.sa/v1/email/send" \
  -H "Authorization: Bearer be_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "noreply@yourdomain.com",
    "from_name": "My App",
    "to": ["user@example.com"],
    "subject": "Hello from Arsel",
    "html": "<h1>Welcome!</h1><p>Your integration is working.</p>"
  }'

Response (202 Accepted):

{
  "id": "01957e3a-4b5c-7d8e-9f0a-1b2c3d4e5f6a"
}

The id is the unique identifier for the queued message. Use it with GET /email/:id to track delivery status.

Next Steps

Topic	Description
Authentication	API key format, generation, and security best practices
Rate Limiting	Request limits, headers, and retry strategies
Pagination	Cursor-based pagination for all list endpoints
Errors	Error response format and status codes
User Guide	Domain verification, DNS setup, and related articles
API Reference	Email, SMS, contacts, and more
SMTP Integration	Send emails via standard SMTP