v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Campaigns

Get a built campaign

Returns the specified campaign version in its fully evaluated (built) runtime form, with all evaluatable fields resolved against current component and setting values. Omit the /version/{version} segment to retrieve the built form of the latest version.

get/v2/campaigns/{campaignId}{version}/built

Path parameters

campaignIdstring required

versionstring required

Response

Successful response

campaign_idstring required

campaign_locksstring[] required

campaign_type'CONFIGURATION' | 'EXTENSION' | 'INTEGRATION' | 'MARKETING' required

descriptionstring required

end_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

incentive_idstring required

is_publishedboolean required

last_published_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

namestring required

parent_versioninteger required

pause_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

program_labelstring required

program_typestring required

start_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

state'ARCHIVED' | 'ENDED' | 'LIVE' | 'NOT_LAUNCHED' | 'PAUSED' | 'STOPPED' required

stop_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

tagsstring[] required

theme_namestring required

updated_datestring required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

variantsstring[] required

versioninteger required

Example response

{
  "components": [
    {
      "created_date": "2025-10-24T02:00:00-07:00",
      "install": "handlebars@installtime:{{install}}",
      "updated_date": "2025-10-24T02:00:00-07:00",
      "variables": [
        {
          "priority": "10",
          "values": {
            "default": "handlebars@runtime:{{default}}",
            "en": "handlebars@runtime:{{en}}"
          }
        }
      ]
    }
  ],
  "end_date": "2025-10-24T02:00:00-07:00",
  "last_published_date": "2025-10-24T02:00:00-07:00",
  "pause_date": "2025-10-24T02:00:00-07:00",
  "start_date": "2025-10-24T02:00:00-07:00",
  "steps": [
    {
      "created_date": "2025-10-24T02:00:00-07:00",
      "data": [
        {
          "default_value": "handlebars@runtime:{{defaultValue}}",
          "value": "handlebars@runtime:{{value}}"
        }
      ],
      "step_builder": "handlebars@runtime:{{stepBuilder}}",
      "triggers": [
        {
          "person_id": "handlebars@runtime:{{personId}}"
        }
      ],
      "updated_date": "2025-10-24T02:00:00-07:00",
      "actions": [
        {
          "reward_tags": "handlebars@runtime:{{rewardTags}}"
        }
      ]
    }
  ],
  "stop_date": "2025-10-24T02:00:00-07:00",
  "updated_date": "2025-10-24T02:00:00-07:00",
  "variant_selector": "handlebars@runtime:{{variantSelector}}"
}