CreateCampaign

CAUTION: it is either “templateCode” or “messages” depending on if you want to base on a template or not

Field	Type	Required	Description
code	string	yes	max length 255 · min length 1
parentCampaignCode	`string	null`
name	string	yes	max length 255 · min length 1
triggerType	CampaignTriggerType	yes	one of: event, schedule, recurring
settings	EventSettings & ScheduleSettings
description	Description
messages	LocalizedMessage
delivery	Delivery
templateCode	TemplateCode		max length 255 · min length 1
segmentCodes	SegmentCodes
segmentRules	SegmentRules
actions	Actions
tracking	Tracking
status	CampaignStatus		one of: active, inactive

Example

{
  "code": "CAMPAIGN1",
  "parentCampaignCode": "CAMPAIGN1_PARENT",
  "name": "Our first campaign",
  "triggerType": "event",
  "settings": {
    "startDate": "2016-07-27T07:45:00Z",
    "endDate": "2016-07-27T07:45:00Z",
    "sendDate": "2016-07-27T07:45:00Z",
    "scheduleType": "2016-07-27T07:45:00Z"
  },
  "description": "description of the entity",
  "delivery": {
    "methods": []
  },
  "templateCode": "TEMPLATE1",
  "segmentRules": {},
  "actions": {
    "primary": {
      "type": "openWebPage",
      "parameter": {
        "url": "https://google.com"
      }
    }
  }
}