Campaigns
Retrieve a list of campaigns for your store
Columns
| Name | Type | References | |
| CampaignId | String | ||
| BrandId | String |
Brands.BrandId | |
| Name | String | ||
| Status | String |
The allowed values are error, onHold, sent, paused, started, stopped, expired, draft, scheduled, canceled. | |
| Type | String |
The allowed values are regular, booster, abTest. | |
| Channel | String |
The allowed values are email, sms, push. | |
| ParentCampaignId | String |
Campaigns.CampaignId | |
| BoosterSendTo | String |
The allowed values are nonOpeners, nonClickers. | |
| BoosterDelay | String | ||
| Language | String | ||
| SenderEmail | String | ||
| SenderName | String | ||
| ReplyToEmail | String | ||
| ContentId | String | ||
| Subject | String | ||
| Preheader | String | ||
| SmsMessage | String | ||
| SmsSenderName | String | ||
| SmsImageId | String | ||
| IsSmsLinkShorteningEnabled | Boolean | ||
| IncludedSegments | String | ||
| ExcludedSegments | String | ||
| SendingStrategy | String |
The allowed values are immediate, scheduled, personalized. | |
| ScheduledAt | Datetime | ||
| OptimizeFor | String |
The allowed values are opens, clicks, orders. | |
| IsTZOptimizationEnabled | Boolean | ||
| AbTest | String | ||
| Url | String | ||
| CreatedAt | Datetime | ||
| StartedAt | Datetime | ||
| EndedAt | Datetime | ||
| UpdatedAt | Datetime |