Perform Experience Action

Lifecycle actions for managing experience state transitions (start, pause, end).

post

Performs an action on an experience to control its lifecycle.

Supported Actions

• start - Activate the experience and begin serving it to visitors

• pause - Temporarily stop serving the experience (can be resumed with start)

• end - Permanently end the experience

Important Notes

• The experience must exist and belong to your organization

• Starting an experience sets it live and removes preview mode

• Pausing or ending an experience returns it to preview mode

• Only certain state transitions are valid (e.g., cannot pause an already ended experience)

Request Body Fields

• variationId (string UUID, optional) — The ID of the variation to apply. When ending an experience, this selects the winning variation.

Usage Examples

Start an experience (no body fields needed):

POST /v25-10-beta/experiences/{experienceId}/actions/start
Body: {}

Pause an experience (no body fields needed for content tests):

POST /v25-10-beta/experiences/{experienceId}/actions/pause
Body: {}

End an experience with a winning variation:

POST /v25-10-beta/experiences/{experienceId}/actions/end
Body: { "variationId": "<uuid>", "updatePricesToVariation": true }

Rate Limit: 10 requests per 60s window, refilling 10 tokens every 60s.

Authorizations

intelligems_access_token

intelligems-access-tokenstringRequired

Intelligems external API access token.

Path parameters

experienceIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

actionstring · enumRequiredPossible values:

Body

application/json

variationIdany ofOptional

string · uuidOptionalPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

or

nullOptional

updatePricesToVariationbooleanOptional

Responses

200

OK

application/json

429

Too Many Requests

application/json

post

/v25-10-beta/experiences/{experienceId}/actions/{action}

HTTPcURLJavaScriptPython

POST /v25-10-beta/experiences/{experienceId}/actions/{action} HTTP/1.1
intelligems-access-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "variationId": "123e4567-e89b-12d3-a456-426614174000",
  "updatePricesToVariation": true
}

{
  "experience": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "isPreview": true,
    "description": "text",
    "devicePreview": {
      "device": "desktop",
      "path": "/"
    },
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "content/advanced",
    "category": "experiment",
    "status": "pending",
    "testTypes": {
      "hasTestPricing": true,
      "hasTestShipping": true,
      "hasTestCampaign": true,
      "hasTestContent": true,
      "hasTestContentUrl": true,
      "hasTestContentAdvanced": true,
      "hasTestContentOnsite": true,
      "hasTestContentTemplate": true,
      "hasTestContentTheme": true,
      "hasTestOnsiteInjections": true,
      "hasTestCheckoutBlocks": true
    },
    "experiencePageTargeting": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "filter": "equals",
        "filterType": "url",
        "value": "text",
        "order": 1,
        "expression": [
          {
            "query": {
              "key": "text",
              "value": "text",
              "filter": "equals",
              "type": "utm"
            },
            "operator": "and"
          }
        ],
        "experienceId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "experienceProductTargeting": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "target": "productPage",
        "expression": [
          {
            "query": {
              "key": "productId",
              "value": "text",
              "filter": "includes",
              "type": "productId"
            },
            "operator": "and"
          }
        ]
      }
    ],
    "experienceActions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "action": "start",
        "actionTs": 1
      }
    ],
    "experienceIntegrations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdAtTs": 1,
        "integration": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "Recharge",
          "description": "text",
          "enabled": true,
          "globalSettings": null,
          "apis": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "description": "text",
              "accessToken": "text",
              "scopes": [
                "read_experiments"
              ],
              "organization": {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text"
              }
            }
          ],
          "lastUpdateTs": 1
        },
        "experienceSettings": null,
        "enabled": false
      }
    ],
    "experienceCustomMetrics": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "order": 1,
        "customEventId": "123e4567-e89b-12d3-a456-426614174000",
        "customEvent": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "identifier": "text",
          "name": "text",
          "description": "text",
          "eventCountLastDay": 1,
          "lastEventTs": 1,
          "error": "text",
          "createdAtTs": 1,
          "archivedAtTs": 1,
          "applyToUrls": [
            {
              "matchBy": "equals",
              "value": "text",
              "error": "text"
            }
          ],
          "experiencesList": [
            "text"
          ],
          "type": "text",
          "settings": {}
        }
      }
    ],
    "experienceKeyMetrics": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "order": 1,
        "isPrimary": false,
        "standardEventId": "conversionRate",
        "experienceCustomMetricId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "currency": {
      "code": "USD",
      "country": "text",
      "options": null,
      "symbol": "$",
      "suffix": "text"
    },
    "variations": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "experienceId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "percentage": 1,
        "isControl": false,
        "order": 1,
        "priceChange": "text",
        "priceChangeUnit": "percent",
        "priceRoundingType": "none",
        "priceRoundingAmount": "text",
        "onsiteEdits": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "onsiteEditType": "html",
            "variationId": "123e4567-e89b-12d3-a456-426614174000",
            "find": "text",
            "title": "text",
            "isRegex": false,
            "replace": "",
            "querySelectors": [
              "text"
            ],
            "skip": false,
            "remove": false,
            "groupId": "text",
            "isHtml": false,
            "isImage": false,
            "insertType": "beforebegin",
            "createdAtUrl": "text",
            "createdAtTs": 1,
            "imageSearchUrl": "text"
          }
        ],
        "onsiteInjections": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "customCss": "text",
          "customJs": "text",
          "jsInjectionMode": {
            "type": "immediately",
            "timeout": 1
          }
        },
        "offer": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "enabled": false,
          "isTest": false,
          "isArchived": false,
          "name": "text",
          "unitType": "dollar",
          "discountType": "dollar",
          "tiers": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "minimumUnits": 1,
              "maximumUnits": 1,
              "unitDiscount": 1,
              "discountTitle": "text",
              "giftWithPurchaseTitle": "text",
              "isFreeShipping": false,
              "isGiftWithPurchase": false,
              "giftWithPurchaseProductId": "text",
              "giftWithPurchaseVariantId": "text",
              "autoAddGiftWithPurchase": false,
              "giftWithPurchaseHandle": "text"
            }
          ],
          "maximumDollarDiscount": 1,
          "discountApplicationType": "tieredDiscount",
          "discountApplicationMethod": "perItem",
          "combinesWithIntelligems": true,
          "combinesWithShopify": true,
          "shouldRejectCodes": true,
          "shippingDiscount": {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "discountType": "percentage",
            "unitDiscount": 1,
            "rateFilter": {
              "type": "text",
              "amount": 1
            },
            "countryFilter": {
              "allow": [
                "text"
              ],
              "exclude": [
                "text"
              ]
            },
            "discountLabel": "text"
          },
          "requireSameItem": false
        },
        "offerId": "123e4567-e89b-12d3-a456-426614174000",
        "shippingRateGroups": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "groupType": "flatRate",
            "position": 1,
            "rates": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text",
                "amount": 1,
                "rateCode": "text",
                "rateType": "amount",
                "currency": "AED",
                "condition": {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "min": 0,
                  "max": 1,
                  "conditionType": "currency",
                  "unit": "g"
                },
                "description": "text"
              }
            ],
            "variationId": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "excludeProducts": false,
        "includeProducts": false,
        "testExperienceId": "text",
        "functionSyncError": false,
        "redirects": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "group": 1,
            "variationId": "123e4567-e89b-12d3-a456-426614174000",
            "originUrl": "text",
            "destinationUrl": "text",
            "queryParams": [
              {
                "key": "text",
                "value": "text"
              }
            ],
            "skip": true,
            "isThemeTest": true,
            "isTemplateTest": true,
            "templateType": "404",
            "templateSuffixes": [
              "text"
            ],
            "redirectOnce": false,
            "filter": "matchesExactly",
            "find": "text",
            "redirectType": "fullReplacement"
          }
        ],
        "userInterfaces": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "isEnabled": true,
            "isArchived": false,
            "widget": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text",
              "enabledSitewide": false,
              "parentId": "123e4567-e89b-12d3-a456-426614174000",
              "widgetType": "messageBoxPopup",
              "config": {
                "desktop": null,
                "mobile": null
              }
            },
            "widgetId": "text",
            "category": "quantityButtons",
            "variationId": "123e4567-e89b-12d3-a456-426614174000",
            "desktopVariables": null,
            "mobileVariables": null,
            "styleOverrides": null
          }
        ],
        "checkoutBlocks": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "variationId": "123e4567-e89b-12d3-a456-426614174000",
            "locationId": "text",
            "blockType": "text",
            "name": "text",
            "variables": {
              "headerText": "text",
              "items": [
                {
                  "order": 1,
                  "title": "text",
                  "subtitle": "text",
                  "type": "text",
                  "icon": "text",
                  "iconColor": "text",
                  "iconSize": "text",
                  "imageSize": 1,
                  "imageAspectRatio": "text",
                  "image": "text",
                  "mediaSpacing": "text"
                }
              ]
            },
            "styles": {
              "typography": {
                "header": {
                  "fontSize": "text",
                  "fontStyle": "text"
                },
                "itemTitle": {
                  "fontSize": "text",
                  "fontStyle": "text"
                },
                "itemSubtitle": {
                  "fontSize": "text",
                  "fontStyle": "text"
                }
              },
              "backgroundColors": {
                "header": "text",
                "item": "text",
                "block": "text"
              },
              "colors": {
                "headerText": "text",
                "itemTitleText": "text",
                "itemSubtitleText": "text"
              },
              "layout": {
                "headerTextAlign": "text",
                "bodyAlign": "text",
                "itemTextAlign": "text",
                "rowCount": 1,
                "columnCount": 1,
                "itemPositionAlign": "text"
              },
              "appearance": {
                "headerBorderThickness": "text",
                "headerBorderStyle": "none",
                "headerCornerRadius": "text",
                "headerPadding": "text",
                "bodySpacing": "text",
                "headingToBodySpacing": "text",
                "blockBorderThickness": "text",
                "blockBorderStyle": "none",
                "blockPadding": "text",
                "blockCornerRadius": "text",
                "itemBorderThickness": "text",
                "itemBorderStyle": "none",
                "itemCornerRadius": "text",
                "itemTextSpacing": "text"
              }
            }
          }
        ]
      }
    ],
    "createdAtTs": 1,
    "isDeleted": true,
    "shippingTestMethodDefinitions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "deliveryProfileId": "text",
        "deliveryLocationGroupId": "text",
        "deliveryZoneId": "text",
        "methodDefinitionId": "text"
      }
    ],
    "audience": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "experienceId": "123e4567-e89b-12d3-a456-426614174000",
      "enabled": true,
      "excludeCurrency": {
        "exclude": true,
        "currency": "text",
        "country": "text",
        "region": "text",
        "city": "text"
      },
      "wholesale": true,
      "audienceType": "common",
      "elseAction": "experienceInclude",
      "elseVariationId": "123e4567-e89b-12d3-a456-426614174000",
      "elseExcludeFromAnalytics": false,
      "filters": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "priority": 1,
          "action": "experienceInclude",
          "filterType": "utm",
          "expression": [
            {
              "query": {
                "key": "text",
                "value": "text",
                "filter": "equals",
                "type": "utm"
              },
              "operator": "and"
            }
          ],
          "expressionType": "common",
          "variationId": "123e4567-e89b-12d3-a456-426614174000",
          "excludeFromAnalytics": false
        }
      ],
      "evaluationFrequency": 1
    },
    "lastUpdateTs": 1,
    "previewPath": "text",
    "isExternal": false,
    "startedAtTs": 1,
    "pausedAtTs": 1,
    "archivedAtTs": 1,
    "requiresLink": false,
    "linkBaseUrl": "text",
    "endedAtTs": 1,
    "productVariantCount": 0,
    "sourceExperienceId": "123e4567-e89b-12d3-a456-426614174000",
    "sourceAction": "duplicate",
    "experienceAnalysis": {
      "analyticsViewType": "test_orders_only"
    }
  }
}