Mailmus

Campaigns

Campaigns Controller_list

GET
/apps/{appId}/campaigns

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Response Body

curl -X GET "https://example.com/apps/string/campaigns"
Empty

Campaigns Controller_create

POST
/apps/{appId}/campaigns

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/campaigns" \  -H "Content-Type: application/json" \  -d '{    "name": "Summer Newsletter",    "subject": "Our summer deals are here 🌞",    "fromEmail": "hello@yourdomain.com",    "templateId": "tpl_abc123",    "domainId": "dom_abc123",    "audienceId": "aud_abc123"  }'
Empty

Campaigns Controller_find One

GET
/apps/{appId}/campaigns/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X GET "https://example.com/apps/string/campaigns/string"
Empty

Campaigns Controller_update

PATCH
/apps/{appId}/campaigns/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/apps/string/campaigns/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty

Campaigns Controller_remove

DELETE
/apps/{appId}/campaigns/{id}

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X DELETE "https://example.com/apps/string/campaigns/string"
Empty

Campaigns Controller_cancel

POST
/apps/{appId}/campaigns/{id}/cancel

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/campaigns/string/cancel"
Empty

Campaigns Controller_cancel Ab Test

POST
/apps/{appId}/campaigns/{id}/ab-test/cancel

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/campaigns/string/ab-test/cancel"
Empty

Campaigns Controller_select Ab Test Winner

POST
/apps/{appId}/campaigns/{id}/ab-test/select-winner

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/campaigns/string/ab-test/select-winner" \  -H "Content-Type: application/json" \  -d '{    "variantId": "clx1234567890"  }'
Empty

Campaigns Controller_send

POST
/apps/{appId}/campaigns/{id}/send

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/campaigns/string/send"
Empty

Campaigns Controller_test Send

POST
/apps/{appId}/campaigns/{id}/test

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/campaigns/string/test" \  -H "Content-Type: application/json" \  -d '{    "to": "test@exemple.com"  }'
Empty

Campaigns Controller_test Send To Seed List

POST
/apps/{appId}/campaigns/{id}/test-seed-list

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/campaigns/string/test-seed-list"
Empty

Campaigns Controller_duplicate

POST
/apps/{appId}/campaigns/{id}/duplicate

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X POST "https://example.com/apps/string/campaigns/string/duplicate"
Empty

Campaigns Controller_export Sends

GET
/apps/{appId}/campaigns/{id}/sends/export

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Response Body

curl -X GET "https://example.com/apps/string/campaigns/string/sends/export"
Empty

Campaigns Controller_get Sends

GET
/apps/{appId}/campaigns/{id}/sends

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*string
appId*string

Query Parameters

status*string

Response Body

curl -X GET "https://example.com/apps/string/campaigns/string/sends?status=string"
Empty