Skip to content

UpdateCampaign

Field Type Required Description
parentCampaignCode `string null`
name string max length 255 · min length 1
triggerType CampaignTriggerType one of: event, schedule, recurring
settings EventSettings & ScheduleSettings
description Description
messages LocalizedMessage
delivery Delivery
segmentCodes SegmentCodes
segmentRules SegmentRules
actions Actions
tracking Tracking
status CampaignStatus one of: active, inactive
{
"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": []
},
"segmentRules": {},
"actions": {
"primary": {
"type": "openWebPage",
"parameter": {
"url": "https://google.com"
}
}
},
"tracking": {
"addUTMToLinks": true
},
"status": "active"
}