v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB

Campaigns

Archive a campaign

Moves the specified campaign version to archived state, hiding it from default campaign listings while retaining it for reporting and recovery. Use POST /v2/campaigns/{id}/unarchive to restore an archived campaign to active state.

post/v2/campaigns/{campaignId}{version}/archive

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 nullable 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.

versioninteger required

Example response

{
  "components": [
    {
      "created_date": "2025-10-24T02:00:00-07:00",
      "display_name": "handlebars@buildtime:{{displayName}}",
      "install": "handlebars@installtime:{{install}}",
      "updated_date": "2025-10-24T02:00:00-07:00",
      "variables": [
        {
          "description": "handlebars@buildtime:{{description}}",
          "priority": "10",
          "values": {
            "default": "handlebars@buildtime:{{default}}",
            "en": "handlebars@buildtime:{{en}}"
          }
        }
      ]
    }
  ],
  "end_date": "2025-10-24T02:00:00-07:00",
  "flow_steps": [
    {
      "apps": [
        {
          "description": "handlebars@buildtime:{{description}}",
          "name": "handlebars@buildtime:{{name}}",
          "type": {
            "name": "handlebars@buildtime:{{name}}"
          }
        }
      ],
      "description": "handlebars@buildtime:{{description}}",
      "flow_path": "handlebars@buildtime:{{flowPath}}",
      "icon_color": "handlebars@buildtime:{{iconColor}}",
      "icon_type": "handlebars@buildtime:{{iconType}}",
      "metrics": [
        {
          "description": "handlebars@buildtime:{{description}}",
          "expression": "handlebars@buildtime:{{expression}}",
          "name": "handlebars@buildtime:{{name}}",
          "tags": "handlebars@buildtime:{{tags}}",
          "unit": "handlebars@buildtime:{{unit}}"
        }
      ],
      "name": "handlebars@buildtime:{{name}}",
      "sequence": "handlebars@buildtime:{{sequence}}",
      "step_name": "handlebars@buildtime:{{stepName}}",
      "tags": "handlebars@buildtime:{{tags}}",
      "words": {
        "person_counting_name": "handlebars@buildtime:{{personCountingName}}",
        "plural_noun_name": "handlebars@buildtime:{{pluralNounName}}",
        "rate_name": "handlebars@buildtime:{{rateName}}",
        "singular_noun_name": "handlebars@buildtime:{{singularNounName}}",
        "verb_name": "handlebars@buildtime:{{verbName}}"
      }
    }
  ],
  "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@buildtime:{{defaultValue}}",
          "dimension": "handlebars@buildtime:{{dimension}}",
          "enabled": "handlebars@buildtime:{{enabled}}",
          "key_type": "handlebars@buildtime:{{keyType}}",
          "name": "handlebars@buildtime:{{name}}",
          "persist_types": "handlebars@buildtime:{{persistTypes}}",
          "scope": "handlebars@buildtime:{{scope}}",
          "value": "handlebars@buildtime:{{value}}"
        }
      ],
      "enabled": "handlebars@buildtime:{{enabled}}",
      "step_builder": "handlebars@buildtime:{{stepBuilder}}",
      "triggers": [
        {
          "enabled": "handlebars@buildtime:{{enabled}}",
          "negated": "handlebars@buildtime:{{negated}}",
          "parent_trigger_group_name": "handlebars@buildtime:{{parentTriggerGroupName}}",
          "trigger_description": "handlebars@buildtime:{{triggerDescription}}",
          "trigger_name": "handlebars@buildtime:{{triggerName}}",
          "trigger_phase": "handlebars@buildtime:{{triggerPhase}}"
        }
      ],
      "updated_date": "2025-10-24T02:00:00-07:00",
      "actions": [
        {
          "enabled": "handlebars@buildtime:{{enabled}}",
          "reward_tags": "handlebars@buildtime:{{rewardTags}}"
        }
      ],
      "aliases": "handlebars@buildtime:{{aliases}}",
      "enabled_on_states": "handlebars@buildtime:{{enabledOnStates}}",
      "journey_names": "handlebars@buildtime:{{journeyNames}}",
      "name": "handlebars@buildtime:{{name}}",
      "scope": "handlebars@buildtime:{{scope}}",
      "selectors": "handlebars@buildtime:{{selectors}}",
      "send_policy": "handlebars@buildtime:{{sendPolicy}}"
    }
  ],
  "stop_date": "2025-10-24T02:00:00-07:00",
  "updated_date": "2025-10-24T02:00:00-07:00",
  "variant_selector": "handlebars@buildtime:{{variantSelector}}",
  "variants": "handlebars@buildtime:{{variants}}"
}