---
title: "Partially Update Autotune"
method: PATCH
path: "/console/v1/autotunes/{id}"
tags: ["Autotunes"]
---

# Partially Update Autotune

`PATCH /console/v1/autotunes/{id}`

Update selected properties of the experiment

## Path parameters

- `id` string, required

## Request body

- AutotunePartialUpdateDto
  - `description` string — A brief summary of what the autotune is being used for.
  - `variants` object[] — An array of Variant objects.
    - `name` string, required — Variant name
    - `json` unknown, required
    - `size` number — Variant size
  - `successEvent` string — The event you are trying to optimize for.
  - `successEventValue` string — The value that should come with the event for it to be considered successful.
  - `explorationWindow` '1hr' | '24hr' | '48hr' | '168hr' | '336hr' | '1' | '24' | '48' | '168' | '336' | '1hrs' | '24hrs' | '48hrs' | '168hrs' | '336hrs' — The initial time period where Autotune will equally split the traffic.
  - `attributionWindow` '1hr' | '2hr' | '4hr' | '24hr' | '1hrs' | '2hrs' | '4hrs' | '24hrs' | '1' | '2' | '4' | '24' — The maximum duration between the exposure and success event that counts as a success.
  - `attributionWindowUnit` 'min' | 'hour' | 'day' — Time unit of attribution window
  - `explorationWindowRate` number, double — Exploration window rate
  - `longtermExplorationAllocation` number, double — Long term exploration allocation
  - `winnerThreshold` '80%' | '90%' | '95%' | '98%' | '99%' — The "probability of best" threshold a variant needs to achieve for Autotune to declare it the winner, stop collecting data, and direct all traffic.
  - `metadataField` string — Metadata field containing the numeric value to optimize for. If this field is null, autotune optimizes for the existence of a follow-up event. This is only used for contextual autotunes.
  - `higherIsBetter` boolean — Whether to optimize for an increase or decrease in the metadata field value. Default is true. This is only used for contextual autotunes.
  - `isContextual` boolean — Whether this is a contextual autotune
  - `metricSourceID` string — Metric source to pull success event data from
  - `linkedExperimentName` string — Linked experiment to measure the success of the Autotune
  - `goalRichText` string — Autotune goal
  - `optimizationParameter` 'occurrence' | 'value' — Optimize for event occurrence vs value
  - `valueColumn` string — Metric source column to optimize for
  - `featureList` string[] — List of features that should be included in the analysis

## Response `200`

Partially Update Autotune Success

- object
  - `message` string, required — A simple string explaining the result of the operation.
  - `data` object, required — A single result.
    - `description` string, required — Detailed description of the configuration’s purpose.
    - `variants` object[], required
      - `name` string, required — Variant name
      - `json` unknown, required
      - `size` number — Variant size
      - `id` string, required — The name that was originally given to the autotune on creation but formatted as an ID ("A Autotune" -> "a_autotune").
    - `successEvent` string, required — The event you are trying to optimize for.
    - `successEventValue` string, required — The value that should come with the event for it to be considered successful.
    - `explorationWindow` '1hr' | '24hr' | '48hr' | '168hr' | '336hr' | '1' | '24' | '48' | '168' | '336' | '1hrs' | '24hrs' | '48hrs' | '168hrs' | '336hrs', required — The initial time period where Autotune will equally split the traffic.
    - `attributionWindow` '1hr' | '2hr' | '4hr' | '24hr' | '1hrs' | '2hrs' | '4hrs' | '24hrs' | '1' | '2' | '4' | '24', required — The maximum duration between the exposure and success event that counts as a success.
    - `attributionWindowUnit` 'min' | 'hour' | 'day' — Time unit of attribution window
    - `explorationWindowRate` number, double — Exploration window rate
    - `longtermExplorationAllocation` number, double — Long term exploration allocation
    - `winnerThreshold` '80%' | '90%' | '95%' | '98%' | '99%', required — The "probability of best" threshold a variant needs to achieve for Autotune to declare it the winner, stop collecting data, and direct all traffic.
    - `metadataField` string — Metadata field containing the numeric value to optimize for. If this field is null, autotune optimizes for the existence of a follow-up event. This is only used for contextual autotunes.
    - `higherIsBetter` boolean — Whether to optimize for an increase or decrease in the metadata field value. Default is true. This is only used for contextual autotunes.
    - `isContextual` boolean — Whether this is a contextual autotune
    - `metricSourceID` string — Metric source to pull success event data from
    - `linkedExperimentName` string — Linked experiment to measure the success of the Autotune
    - `goalRichText` string — Autotune goal
    - `optimizationParameter` 'occurrence' | 'value' — Optimize for event occurrence vs value
    - `valueColumn` string — Metric source column to optimize for
    - `featureList` string[] — List of features that should be included in the analysis
    - `inlineTargetingRulesJSON` string, nullable — A raw JSON string of the inline targeting rules
    - `inlineTargetingRules` object[] — A formatted array of the inline targeting rules
      - `name` string, required — The name of this rule.
      - `passPercentage` number, required — Of the users that meet the conditions of this rule, what percent should return true.
      - `conditions` object[], required — An array of Condition objects.
        - `targetValue` union
          - string[]
          - number[]
          - string
          - number
        - `operator` string
        - `field` string, nullable
        - `customID` string, nullable
        - `type` 'app_version' | 'browser_name' | 'browser_version' | 'country' | 'custom_field' | 'email' | 'environment_tier' | 'fails_gate' | 'fails_segment' | 'ip_address' | 'locale' | 'os_name' | 'os_version' | 'passes_gate' | 'passes_segment' | 'public' | 'time' | 'unit_id' | 'user_id' | 'user_agent' | 'url' | 'javascript' | 'device_model' | 'target_app' | 'experiment_group', required
      - `environments` string[], nullable — The environments this rule is enabled for.
      - `id` string — The Statsig ID of this rule.
      - `baseID` string — The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout
      - `returnValue` object — The return value of the rule.
      - `completedAutomatedRollouts` object[] — Read-only: Automated rollout phases that have already completed.
        - `time` number
        - `passPercent` number, required
      - `pendingAutomatedRollouts` object[] — Read-only: Automated rollout phases that are scheduled but not yet complete.
        - `time` number
        - `passPercent` number, required
    - `id` string, required — ID
    - `name` string — Optional name for the configuration.
    - `idType` string, required — Type of ID
    - `lastModifierID` string, nullable, required — ID of the last modifier.
    - `lastModifiedTime` number, double, nullable, required — Time of the last modification.
    - `lastModifierEmail` string, nullable, required — Email of the last modifier.
    - `lastModifierName` string, nullable, required — Name of the last modifier.
    - `creatorID` string, nullable, required — ID of the user who created the entity.
    - `createdTime` number, double, required — Timestamp when the entity was created.
    - `creatorName` string, nullable, required — Name of the creator.
    - `creatorEmail` string, nullable, required — Email of the creator.
    - `tags` string[] — Optional tags for categorization.
    - `targetApps` string[] — List of target applications associated with this configuration.
    - `holdoutIDs` string[] — Holdouts applied to this configuration.
    - `team` string, nullable — Optional name for the responsible team.
    - `teamID` string, nullable — Optional ID of the responsible team.
    - `version` number, double — Version number
    - `isStarted` boolean, required — Is the autotune experiment currently running.
    - `winner` object, nullable, required
      - `id` string, required — The Statsig ID of the winner group.
      - `name` string, required — The name of the winner group.

## Other responses

- `400` — Invalid request. Please check the request input and try again.
- `401` — This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
- `404` — Not Found. The requested resource could not be found.

---

[API](https://skmtc.net/statsig/apis/console-api.md) · [All operations](https://skmtc.net/statsig/apis/console-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/statsig/console-api/versions/3189f450c93b/schema)