---
title: "PUT /api/v1/experiments/{experimentId}/variants/{name}/_promote"
method: PUT
path: "/api/v1/experiments/{experimentId}/variants/{name}/_promote"
tags: ["Experiment"]
---

# PUT /api/v1/experiments/{experimentId}/variants/{name}/_promote

`PUT /api/v1/experiments/{experimentId}/variants/{name}/_promote`

## Path parameters

- `experimentId` string, required
- `name` string, required

## Request body

- ExperimentVariantForm
  - `description` string

## Response `default`

default response

- ResponseEntitySingleExperimentView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` Experiment
    - `name` string
    - `description` string
    - `id` string
    - `status` 'RUNNING' | 'SCHEDULED' | 'ENDED' | 'DRAFT' | 'ARCHIVED'
    - `trafficProportion` TrafficProportion
      - `type` 'SPLIT_EVENLY' | 'CUSTOM_PERCENTAGES'
      - `variants` ExperimentVariant[]
        - `id` string
        - `name` string
        - `weight` number, float
        - `url` string
        - `promoted` boolean
    - `scheduling` Scheduling
      - `startDate` string, date-time
      - `endDate` string, date-time
    - `trafficAllocation` number, float
    - `creationDate` string, date-time
    - `modDate` string, date-time
    - `pageId` string
    - `createdBy` string
    - `lastModifiedBy` string
    - `goals` Goals
      - `primary` Goal
        - `metric` Metric
          - `name` string
          - `description` string
          - `category` 'DIFFERENTIATING_FEATURES' | 'PAID_FEATURES' | 'PLATFORM_SPECIFIC_CUSTOMIZATION' | 'SOPHISTICATED_CONTENT_ARCHITECTURE' | 'POSITIVE_USER_EXPERIENCE' | 'PLATFORM_SPECIFIC_DEVELOPMENT' | 'RECENT_ACTIVITY' | 'HISTORY_LEGACY_DEPRECATED_FEATURES'
          - `feature` 'CONTENTLETS' | 'LANGUAGES' | 'CONTENT_TYPES' | 'SITES' | 'URL_MAPS' | 'WORKFLOW' | 'USERS' | 'SITE_SEARCH' | 'IMAGE_API' | 'LAYOUT' | 'CONTENT_TYPE_FIELDS'
        - `type` 'MINIMIZE' | 'MAXIMIZE'
    - `targetingConditions` TargetingCondition[]
      - `id` string
      - `conditionKey` string
      - `values` object
        - `empty` boolean
      - `operator` 'AND' | 'OR'
    - `lookBackWindowExpireTime` integer
    - `runningIds` RunningIds
      - `ids` RunningId[]
        - `id` string
        - `startDate` string, date-time
        - `endDate` string, date-time
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

---

[API](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api.md) · [All operations](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/anzworldline-solutions/dotcms-rest-api/revisions/0f38cbc3bd36/schema)