Request & Response Format

Request Format

All API requests must be sent as HTTP POST requests (unless specified otherwise) with JSON-formatted request bodies. The Content-Type header must be set to application/json.

Standard Request Structure:

{
    "owner_id": "your_owner_id",
    "token": "your_api_token",
    "smtp_user_name": "your_smtp_user",
    // Additional parameters specific to the endpoint
}

Response Format

API responses are returned in JSON format and follow a consistent structure across all endpoints.

Success Response Structure:

{
    "status": "success",
    "code": 200,
    "message": "Operation completed successfully",
    "data": {
        // Response data specific to the endpoint
    }
}

❗️
Important
Response Structure:

{
    "status": "error",
    "code": 400,
    "type": "validation_error",
    "message": "Detailed error description"
}

HTTP Status Codes

Status Code	Meaning	Description
200	OK	Request successful, operation completed
400	Bad Request	Invalid request parameters or format
401	Unauthorized	Invalid or missing authentication credentials
403	Forbidden	Valid credentials but insufficient permissions
404	Not Found	Requested resource does not exist
429	Too Many Requests	Rate limit exceeded, slow down requests