Update a Feature

1 min

PATCH

https://api.optimizely.com/v2/features/{feature_id}

Update a feature by ID.

Path Parameters

feature_idinteger<int64>required
Description
The unique identifier for the Feature
Format
int64

Body Parameters

bodyFeatureUpdaterequired
Description
A string in JSON format that includes all the fields you'd like to change for a Feature
- archivedboolean
  Description
  Whether the Feature has been archived
- descriptionstring
  Description
  A short description of this Feature
- environmentsmap<string, FeatureEnvironment>
  Description
  The configuration for this Feature's Rollout within each Environment, keyed by Environment key.
- keystring
  Example
  new_checkout_page
  Description
  Unique string identifier for this Feature within the Project
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\-]+$
- namestring
  Example
  the checkout feature
  Description
  Name of the Feature
- variablesFeatureVariableUpdate[]
  Description
  Variables define the dynamic configuration of a feature, and each variable can take on a different value on a per-variation basis within a feature test.
  - archivedboolean
    Description
    Whether or not this Feature Variable is archived
    Default
    false
  - default_valuestring
    Example
    0.05
    Description
    The stringified default value for this Feature Variable. The default value is the value Optimizely SDKs will return when this Feature Variable is accessed by getFeatureVariableValue unless the Feature Variable's value is a part of a feature test variation.
  - descriptionstring
    Description
    A short description of this Feature Variable
  - idinteger<int64>
    Description
    The ID of this Feature Variable
    Format
    int64
  - keystring
    Description
    Unique string identifier for this Feature Variable within the Feature
  - typestring<boolean | string | double | integer | json>
    Description
    The datatype for this Feature Variable
    Allowed
    booleanstringdoubleintegerjson

Responses

200Successfully updated the Feature

Feature
- archivedboolean
  Description
  Whether the Feature has been archived
  Default
  false
- createdstring<date-time>
  Description
  Time when the Feature was created
  Format
  date-time
- descriptionstring
  Description
  A short description of this Feature
- environmentsmap<string, FeatureEnvironment>
  Description
  The configuration for this Feature's Rollout within each Environment, keyed by Environment key
- idinteger<int64>
  Description
  The ID of this Feature
  Format
  int64
- keystringrequired
  Example
  new_checkout_page
  Description
  Unique string identifier for this Feature within the Project
  Max Length
  64
  Pattern
  ^[a-zA-Z0-9_\-]+$
- last_modifiedstring<date-time>
  Description
  Date last modified
  Format
  date-time
- namestring
  Example
  the checkout feature
  Description
  Name of the Feature
- project_idinteger<int64>required
  Description
  The ID of the Project this Feature belongs to
  Format
  int64
- variablesFeatureVariable[]
  Description
  Variables define the dynamic configuration of a feature, and each variable can take on a different value on a per-variation basis within a feature test.
  - archivedboolean
    Description
    Whether or not this Feature Variable is archived
    Default
    false
  - default_valuestringrequired
    Example
    0.05
    Description
    The stringified default value for this Feature Variable. The default value is the value Optimizely SDKs will return when this Feature Variable is accessed by getFeatureVariableValue unless the Feature Variable's value is a part of a feature test variation.
  - idinteger<int64>
    Description
    The ID of this Feature Variable
    Format
    int64
  - keystringrequired
    Description
    Unique string identifier for this Feature Variable within the Feature
  - typestring<boolean | string | double | integer | json>required
    Example
    double
    Description
    The datatype for this Feature Variable
    Allowed
    booleanstringdoubleintegerjson

400Invalid request body content

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to update specified Feature

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

404Feature not found

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request PATCH \
     --url https://api.optimizely.com/v2/features/{feature_id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/features/{feature_id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/features/{feature_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/features/{feature_id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// Successfully updated the Feature
{
  "archived": false,
  "created": "",
  "description": "",
  "environments": "",
  "id": "",
  "key": "new_checkout_page",
  "last_modified": "",
  "name": "the checkout feature",
  "project_id": "",
  "variables": [
    {
      "archived": false,
      "default_value": "0.05",
      "id": "",
      "key": "",
      "type": "double"
    }
  ]
}

400

// Invalid request body content
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to update specified Feature
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

// Feature not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}