Core API Documentation Help

Campaigns (draft)

List all campaigns

/campaigns

Responses

[]

Handle POST request.

/campaign-analytics

Request parameters

{ "campaignId": "example" }

Responses

Endpoint for CAMPAIGN (Get)

/campaign

Request parameters

Responses

Endpoint for CAMPAIGN (Put)

/campaign

Request parameters

{ "settings": "example", "distributionLists": "example", "status": "example", "name": "example", "description": "example", "channels": "example", "sendDate": "example", "endDate": "example" }

Responses

Endpoint for CAMPAIGN (Post)

/campaign

Request parameters

{ "name": "example", "status": "example", "type": "example", "description": "example", "channels": "example", "settings": "example" }

Responses

Endpoint for CAMPAIGN (Delete)

/campaign

Request parameters

Responses

Handle post request to send email campaign

/campaign-preview

Request parameters

{ "campaignId": "example", "recipient": "example" }

Responses

Endpoint for CAMPAIGN-PREVIEW-SEND (Post)

/campaign-preview-send

Request parameters

{ "recipient": "example", "campaignId": "example", "channel": "example" }

Responses

Endpoint for CAMPAIGN-TEMPLATE (Get)

/campaign-template

Request parameters

Responses

Endpoint for CAMPAIGN-TEMPLATE-DOWNLOAD (Get)

/campaign-template-download

Request parameters

Responses

Endpoint for CAMPAIGN-SENDER (Get)

/campaign-sender

Request parameters

Responses

Endpoint for CAMPAIGN-STATS (Get)

/campaign-stats

Request parameters

Responses

01 September 2026