Skip to main content

API Reference

The Arsel API provides RESTful endpoints for sending and tracking transactional email and SMS messages. All endpoints use JSON request and response bodies.

Base URL

https://api.arsel.sa/api/v1

Email Endpoints

MethodEndpointDescription
POST/email/sendSend a transactional email
GET/emailList sent emails with delivery status
GET/email/:idGet detailed status for a specific email
Verified Domain Required

All email sending requires a verified domain. Verify your domain in the Arsel Dashboard under Settings > Domains before sending.

SMS Endpoints

MethodEndpointDescription
POST/sms/sendSend a transactional SMS
GET/smsList sent SMS messages with delivery status
GET/sms/:idGet detailed status for a specific SMS
Verified Sender Name Required

All SMS sending requires a registered sender name. Register your sender name in the Arsel Dashboard under Settings > SMS Senders before sending.

Common Headers

Every request must include:

HeaderValue
AuthorizationBearer <your-api-key>
Content-Typeapplication/json

Response Conventions

Sending endpoints return 202 Accepted — the message has been queued for delivery, not yet sent. Use the status endpoints to track delivery progress.

List endpoints return 200 OK with paginated results:

{
"data": [],
"meta": {
"total": 100,
"page": 1,
"limit": 20,
"totalPages": 5,
"hasNextPage": true,
"hasPrevPage": false
}
}

Error responses follow a consistent format across all endpoints. See Errors for details.