Send campaign preview email

POST

/campaign-preview/send

Sends preview emails for a campaign to relevant store users.

Business Rules:

Campaign must exist and be accessible

Sends emails to users associated with stores that have campaign allocations

Uses campaign-specific email templates

Includes campaign details and store-specific information

Email Content:

Campaign name and reference

Store name and details

Campaign start and end dates

Store manager information

Campaign preview link

Side Effects:

Sends emails asynchronously to store users

Logs email sending activities

Does not modify campaign data

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Preview emails sent successfully

Body

🟠400Bad Request

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://prod.your-api-server.com/campaign-preview/send' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaignId": "550e8400-e29b-41d4-a716-446655440000"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "emailsSent": 0
}

Modified at 2025-09-25 10:04:16

Publish a campaign

Get campaign statistics