Perform Experience Action

Perform experience action

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: 50 requests per 30s window, refilling 25 tokens every 30s.

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

Request

Path parameters

experienceIdstring uuid required
action'start' | 'pause' | 'end' required

Request body

variationIdstring uuid nullable
updatePricesToVariationboolean

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.