API Introduction & Authentication - Hotsol API Reference

Welcome to the Hotsol API

The Hotsol REST API allows you to integrate lists, segments, campaigns, templates, support channels, and reporting analytics directly into your own customer systems and applications.

API Endpoint Base URL

https://api.hotsol.net/api/v1

Authentication

To authorize your REST client, you must pass the Private Secret API Key (generated from your Hotsol Client Panel settings) in one of the following formats:

1. HTTP Bearer Token (Recommended)

Authorization: Bearer hk_sec_your_secret_key_here

2. Custom HTTP Header

X-API-Key: hk_sec_your_secret_key_here

3. Query String Parameter

https://api.hotsol.net/api/v1/lists?api_key=hk_sec_your_secret_key_here

Global Rate Limits

API requests are subject to rate limiting of 60 requests per minute per client key.

Response Header	Description
X-RateLimit-Limit	The maximum number of allowed requests per minute (e.g. 60).
X-RateLimit-Remaining	The remaining number of allowed requests in the current window.

Standard Response Format

All responses are serialized in UTF-8 JSON. Every response follows a consistent wrapper structure containing a success boolean, a message context string, and the actual payload inside data.

Success Response (200 OK)

{
    "success": true,
    "message": "Resource retrieved successfully.",
    "data": { ... }
}

Error Response Example (401 Unauthenticated)

{
    "success": false,
    "message": "Invalid API key."
}

Validation Failure Example (422 Unprocessable Content)

{
    "success": false,
    "message": "The given data was invalid.",
    "errors": {
        "email": [
            "The email field must be a valid email address."
        ]
    }
}