API Documentation
Request format, response conventions, pagination, and HTTP methods.
The Cloud Server for Email REST API follows standard REST conventions. Endpoints use predictable, resource-oriented URLs. HTTP methods define actions. JSON is used for request and response bodies. HTTP status codes indicate success or failure.
Request Format
POST /v1/messages HTTP/1.1
Host: api.cloudserverforemail.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json
{
"from": "sender@yourdomain.com",
"to": ["recipient@example.com"],
"subject": "Your subject",
"html": "<p>Message body</p>"
}
Response Format
All responses return JSON. Successful responses include a status field. Error responses include error and message fields.
Success
{"id":"msg_01J...","status":"queued","queued_at":"2026-04-08T12:00:00Z"}Error
{"error":"invalid_request","message":"The 'to' field must contain at least one valid email address."}HTTP Methods
| Method | Use |
|---|---|
| GET | Retrieve a resource or list of resources |
| POST | Create a resource or trigger an action |
| PUT | Replace a resource entirely |
| PATCH | Update specific fields of a resource |
| DELETE | Remove a resource |
Pagination
List endpoints return paginated results. Use limit and offset query parameters to paginate.
GET /v1/messages?limit=50&offset=100&start_date=2026-04-01
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Results per page (max 250, default 50) |
| offset | integer | Number of results to skip (default 0) |