Campaign Preview

Retrieve delivery servers, CAN-SPAM compliance footer, triggers, and target scopes of a campaign.
GET /campaigns/{uuid}/preview

Fetches the campaign configuration context details (loaded delivery servers, CAN-SPAM compliance layout, triggers for AutoResponders, and lists/segments targeted scope details).

URL Parameters

Parameter Type Status Description
uuid String (UUID or ID) Required The unique UUID or physical numeric ID of the campaign.

cURL Example

curl -X GET "https://api.hotsol.net/api/v1/campaigns/9c8a7b6f-4a3b-4c2d-9e1f-88b77a66c5d4/preview" \
     -H "Authorization: Bearer hk_sec_your_secret_key_here" \
     -H "Accept: application/json"

Response Example

{
    "success": true,
    "message": "Campaign preview retrieved successfully.",
    "data": {
        "campaign": {
            "id": 8,
            "uuid": "9c8a7b6f-4a3b-4c2d-9e1f-88b77a66c5d4",
            "campaign_type": "regular",
            "campaign_name": "Summer Promotion 2026",
            "subject": "Get 20% off all plans this summer!",
            "message": "<p>Summer sales is on! ...</p>",
            "status": "sent",
            "triggers": [],
            "delivery_server": {
                "id": 2,
                "uuid": "2bc983df-2dfc-4d3b-8a14-23a74b68e9f5",
                "hostname": "smtp.sendgrid.net",
                "port": 587,
                "username": "apikey",
                "protocol": "smtp",
                "status": "active"
            },
            "canspam": {
                "id": 1,
                "company_name": "Hotsol Corp",
                "phone": "+1-800-555-0199",
                "website": "https://hotsol.io",
                "address_1": "100 Main St",
                "city": "Boston",
                "state": "MA",
                "zip_code": "02108",
                "country_id": 1
            }
        },
        "targeting": [
            {
                "list_id": 1,
                "segment_id": null
            },
            {
                "list_id": 1,
                "segment_id": 5
            }
        ]
    }
}