Email Lists

Manage your mailing and subscriber lists inside your customer account.
GET /lists

Retrieves a paginated list of all mailing/subscriber lists belonging to the authenticated customer.

Query Parameters

Parameter Type Status Description
per_page Integer Optional Number of records to return per page (Default: 15, Max: 100).
page Integer Optional The page number of results to fetch (Default: 1).

cURL Example

curl -X GET "https://api.hotsol.net/api/v1/lists?per_page=2" \
     -H "Authorization: Bearer hk_sec_your_secret_key_here" \
     -H "Accept: application/json"

Response Example

{
    "success": true,
    "message": "Lists retrieved successfully.",
    "data": [
        {
            "id": 1,
            "uuid": "4c8f9db0-4fdc-4a3b-9a84-18a72b64d1f2",
            "name": "Weekly Newsletter",
            "from_email": "newsletter@domain.com",
            "from_name": "My Business",
            "reply_to": "support@domain.com",
            "description": "Subscribers for the general newsletter.",
            "status": "active",
            "total_subscriber": 1042,
            "created_at": "2026-08-15T12:00:00.000000Z",
            "updated_at": "2026-08-22T08:00:00.000000Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "last_page": 5,
        "per_page": 2,
        "total": 10
    }
}
POST /lists

Creates a new mailing list for the authenticated customer.

Request Parameters

Parameter Type Status Description
name String Required The name of the mailing list. Must be unique per customer.
description String Optional A short description detailing the purpose of the list.

Example Payload

{
    "name": "Acme VIP Club",
    "description": "Subscribers registered as high-value clients."
}

Response Example

{
    "success": true,
    "message": "List created successfully.",
    "data": {
        "id": 15,
        "uuid": "7a3bd0d3-c90a-429a-8b84-ea17b64d1f2e",
        "customer_id": 1,
        "name": "Acme VIP Club",
        "description": "Subscribers registered as high-value clients.",
        "status": "active",
        "created_at": "2026-08-23T15:35:00.000000Z",
        "updated_at": "2026-08-23T15:35:00.000000Z"
    }
}