Campaign element reference

This topic outlines the JSON objects needed to create each campaign step when creating campaigns. Insert these objects into the elements array when creating campaigns using the application API.

Element Example
Segment Members
[
  {
    "type": "CampaignSegment",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Segment Members",
    "memberCount": "0",
    "memberErrorCount": "0",
    "outputTerminals": [
      {
        "type": "CampaignOutputTerminal",
        "id": "1814",
        "connectedId": "2204",
        "connectedType": "CampaignWaitAction",
        "terminalType": "out"
      }
    ]
  }
]
Landing Page (reporting only)
[
  {
    "type": "CampaignLandingPage",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Landing Page (reporting only)",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "116",
      "y": "82"
    }
  }
]
Email
[
  {
    "type": "CampaignEmail",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Email",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "120",
      "y": "83"
    },
    "sendTimePeriod": "sendAllEmailAtOnce",
    "includeListUnsubscribeHeader": "true",
    "isAllowingResend": "false",
    "isAllowingSentToMasterExclude": "false",
    "isAllowingSentToUnsubscribe": "false",
    "stoType": "none"
  }
]
Form (reporting only)
[
  {
    "type": "CampaignForm",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Form (reporting only)",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "52"
    }
  }
]
Clicked Email?
[
  {
    "type": "CampaignEmailClickthroughRule",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Clicked Email?",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "51"
    },
    "evaluateNoAfter": "0",
    "numberOfClicks": "1",
    "withinLast": "604800"
  }
]
Compare Contact Fields
[
  {
    "type": "CampaignContactFieldComparisonRule",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Compare Contact Fields",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "50"
    },
    "evaluateNoAfter": "0"
  }
]
Compare Custom Object Fields
[
  {
    "type": "CampaignCustomObjectFieldComparisonRule",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Compare Custom Object Fields",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "57"
    },
    "evaluateNoAfter": "0"
  }
]
Shared List Member?
[
  {
    "type": "CampaignContactListMembershipRule",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Shared List Member?",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "1",
      "y": "55"
    },
    "evaluateNoAfter": "0"
  }
]
Shared Filter Member?
[
  {
    "type": "CampaignContactFilterMembershipRule",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Shared Filter Member?",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "73"
    },
    "evaluateNoAfter": "0"
  }
]
Opened Email?
[
  {
    "type": "CampaignEmailOpenedRule",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Opened Email?",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "56"
    },
    "evaluateNoAfter": "0",
    "numberOfOpens": "1",
    "withinLast": "604800"
  }
]
Sent Email?
[
  {
    "type": "CampaignEmailSentRule",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Sent Email?",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "63"
    },
    "evaluateNoAfter": "0"
  }
]
Submitted Form?
[
  {
    "type": "CampaignSubmitFormRule",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Submitted Form?",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "39"
    },
    "evaluateNoAfter": "0",
    "withinLast": "604800"
  }
]
Visited Website?
[
  {
    "type": "CampaignWebsiteVisitRule",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Visited Website?",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "40"
    },
    "evaluateNoAfter": "0",
    "numberOfVisits": "1",
    "withinLast": "604800"
  }
]
Add to Program
[
  {
    "type": "CanvasAddToProgramAction",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Add to Program",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "45"
    }
  }
]
Move to Program
[
  {
    "type": "CanvasMoveToProgramAction",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Move to Program",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "51"
    }
  }
]
Add to Campaign
[
  {
    "type": "CampaignAddToCampaignAction",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Add to Campaign",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "6",
      "y": "70"
    }
  }
]
Add to Program Builder
[
  {
    "type": "CampaignAddToProgramBuilderAction",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Add to Program Builder",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "41"
    }
  }
]
Add to Shared List
[
  {
    "type": "CampaignAddToContactListAction",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Add to Shared List",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "47"
    }
  }
]
Move to Campaign
[
  {
    "type": "CampaignMoveToCampaignAction",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Move to Campaign",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "51"
    }
  }
]
Move to Program Builder
[
  {
    "type": "CampaignMoveToProgramBuilderAction",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Move to Program Builder",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "41"
    }
  }
]
Move to Shared List
[
  {
    "type": "CampaignMoveToContactListAction",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Move to Shared List",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "26"
    }
  }
]
Wait
[
  {
    "type": "CampaignWaitAction",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Wait",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "76"
    },
    "isNotificationEnabled": "False"
  }
]
Remove from Shared List
[
  {
    "type": "CampaignRemoveFromContactListAction",
    "id": "<nextAvailableNegativeNumber>",
    "name": "Remove from Shared List",
    "memberCount": "0",
    "memberErrorCount": "0",
    "position": {
      "type": "Position",
      "x": "0",
      "y": "57"
    }
  }
]
  

[Creating campaigns, creating complex campaigns, campaign steps, campaign step, campaign element, campaign elements.]

Related

Creating campaigns with steps using the application API

Eloqua API tutorials

Campaigns application API endpoints

Application API