Partially update a feature

POST

features

{id}

cURL

curl -X POST 'https://api.growthbook.io/api/v1/features/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v1/features/{id}"

payload = {
    "description": "<string>",
    "archived": True,
    "project": "<string>",
    "targetingAllProjects": True,
    "targetingProjects": ["<string>"],
    "owner": "<string>",
    "defaultValue": "<string>",
    "baseConfig": "<string>",
    "tags": ["<string>"],
    "environments": {},
    "prerequisites": ["<string>"],
    "jsonSchema": "<string>",
    "customFields": {},
    "holdout": {
        "id": "<string>",
        "value": "<string>"
    },
    "ignoreWarnings": True,
    "skipSchemaValidation": True,
    "skipHooks": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    archived: true,
    project: '<string>',
    targetingAllProjects: true,
    targetingProjects: ['<string>'],
    owner: '<string>',
    defaultValue: '<string>',
    baseConfig: '<string>',
    tags: ['<string>'],
    environments: {},
    prerequisites: ['<string>'],
    jsonSchema: '<string>',
    customFields: {},
    holdout: {id: '<string>', value: '<string>'},
    ignoreWarnings: true,
    skipSchemaValidation: true,
    skipHooks: true
  })
};

fetch('https://api.growthbook.io/api/v1/features/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v1/features/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'archived' => true,
    'project' => '<string>',
    'targetingAllProjects' => true,
    'targetingProjects' => [
        '<string>'
    ],
    'owner' => '<string>',
    'defaultValue' => '<string>',
    'baseConfig' => '<string>',
    'tags' => [
        '<string>'
    ],
    'environments' => [
        
    ],
    'prerequisites' => [
        '<string>'
    ],
    'jsonSchema' => '<string>',
    'customFields' => [
        
    ],
    'holdout' => [
        'id' => '<string>',
        'value' => '<string>'
    ],
    'ignoreWarnings' => true,
    'skipSchemaValidation' => true,
    'skipHooks' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v1/features/{id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"archived\": true,\n  \"project\": \"<string>\",\n  \"targetingAllProjects\": true,\n  \"targetingProjects\": [\n    \"<string>\"\n  ],\n  \"owner\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"baseConfig\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"environments\": {},\n  \"prerequisites\": [\n    \"<string>\"\n  ],\n  \"jsonSchema\": \"<string>\",\n  \"customFields\": {},\n  \"holdout\": {\n    \"id\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"ignoreWarnings\": true,\n  \"skipSchemaValidation\": true,\n  \"skipHooks\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/features/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"archived\": true,\n  \"project\": \"<string>\",\n  \"targetingAllProjects\": true,\n  \"targetingProjects\": [\n    \"<string>\"\n  ],\n  \"owner\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"baseConfig\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"environments\": {},\n  \"prerequisites\": [\n    \"<string>\"\n  ],\n  \"jsonSchema\": \"<string>\",\n  \"customFields\": {},\n  \"holdout\": {\n    \"id\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"ignoreWarnings\": true,\n  \"skipSchemaValidation\": true,\n  \"skipHooks\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v1/features/{id}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"archived\": true,\n  \"project\": \"<string>\",\n  \"targetingAllProjects\": true,\n  \"targetingProjects\": [\n    \"<string>\"\n  ],\n  \"owner\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"baseConfig\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"environments\": {},\n  \"prerequisites\": [\n    \"<string>\"\n  ],\n  \"jsonSchema\": \"<string>\",\n  \"customFields\": {},\n  \"holdout\": {\n    \"id\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"ignoreWarnings\": true,\n  \"skipSchemaValidation\": true,\n  \"skipHooks\": true\n}"

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

{
  "feature": {
    "id": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "archived": true,
    "description": "<string>",
    "owner": "<string>",
    "project": "<string>",
    "valueType": "boolean",
    "defaultValue": "<string>",
    "tags": [
      "<string>"
    ],
    "environments": {},
    "revision": {
      "version": 123,
      "comment": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "publishedBy": "<string>",
      "id": "<string>"
    },
    "ownerEmail": "<string>",
    "targetingAllProjects": true,
    "targetingProjects": [
      "<string>"
    ],
    "baseConfig": "<string>",
    "defaultValueConfig": "<string>",
    "prerequisites": [
      "<string>"
    ],
    "customFields": {},
    "holdout": {
      "id": "<string>",
      "value": "<string>"
    }
  },
  "bypassedGates": [
    {
      "type": "<string>",
      "outcome": "bypassed",
      "via": "ignoreWarnings"
    }
  ]
}

Authorizations

Authorization

string

header

required

If using Bearer auth, pass the Secret Key as the token:

curl https://api.growthbook.io/api/v1/features   -H "Authorization: Bearer secret_abc123DEF456"

Path Parameters

string

required

The id of the requested resource

Body

application/json

description

string

Description of the feature

Maximum string length: 10000

archived

boolean

project

string

An associated project ID

targetingAllProjects

boolean

Make this feature discoverable in — and served to — every project, beyond its primary project. Governance/approvals stay with project.

targetingProjects

string[]

Secondary project IDs this feature is targeted in and served to, beyond its primary project. Governance/approvals stay with project.

owner

string

The userId or email address of the owner. If an email address is provided, it will be used to look up the userId of the matching organization member. If an ID is provided, it will be validated as existing in the organization.

defaultValue

string

baseConfig

string | null

The config backing this flag ("Config mode"), fixed at creation. Cannot be changed by an update — resend the current value or omit it; a different value (or null to detach) is rejected.

Response

200 - application/json

Resource created

feature

object

required

Show child attributes

bypassedGates

object[]

Gates that would have blocked this publish but were bypassed by the caller's authority. Present only when at least one gate was bypassed.

Show child attributes

cURL

curl -X POST 'https://api.growthbook.io/api/v1/features/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

import requests

url = "https://api.growthbook.io/api/v1/features/{id}"

payload = {
    "description": "<string>",
    "archived": True,
    "project": "<string>",
    "targetingAllProjects": True,
    "targetingProjects": ["<string>"],
    "owner": "<string>",
    "defaultValue": "<string>",
    "baseConfig": "<string>",
    "tags": ["<string>"],
    "environments": {},
    "prerequisites": ["<string>"],
    "jsonSchema": "<string>",
    "customFields": {},
    "holdout": {
        "id": "<string>",
        "value": "<string>"
    },
    "ignoreWarnings": True,
    "skipSchemaValidation": True,
    "skipHooks": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    archived: true,
    project: '<string>',
    targetingAllProjects: true,
    targetingProjects: ['<string>'],
    owner: '<string>',
    defaultValue: '<string>',
    baseConfig: '<string>',
    tags: ['<string>'],
    environments: {},
    prerequisites: ['<string>'],
    jsonSchema: '<string>',
    customFields: {},
    holdout: {id: '<string>', value: '<string>'},
    ignoreWarnings: true,
    skipSchemaValidation: true,
    skipHooks: true
  })
};

fetch('https://api.growthbook.io/api/v1/features/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growthbook.io/api/v1/features/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'archived' => true,
    'project' => '<string>',
    'targetingAllProjects' => true,
    'targetingProjects' => [
        '<string>'
    ],
    'owner' => '<string>',
    'defaultValue' => '<string>',
    'baseConfig' => '<string>',
    'tags' => [
        '<string>'
    ],
    'environments' => [
        
    ],
    'prerequisites' => [
        '<string>'
    ],
    'jsonSchema' => '<string>',
    'customFields' => [
        
    ],
    'holdout' => [
        'id' => '<string>',
        'value' => '<string>'
    ],
    'ignoreWarnings' => true,
    'skipSchemaValidation' => true,
    'skipHooks' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growthbook.io/api/v1/features/{id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"archived\": true,\n  \"project\": \"<string>\",\n  \"targetingAllProjects\": true,\n  \"targetingProjects\": [\n    \"<string>\"\n  ],\n  \"owner\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"baseConfig\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"environments\": {},\n  \"prerequisites\": [\n    \"<string>\"\n  ],\n  \"jsonSchema\": \"<string>\",\n  \"customFields\": {},\n  \"holdout\": {\n    \"id\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"ignoreWarnings\": true,\n  \"skipSchemaValidation\": true,\n  \"skipHooks\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.growthbook.io/api/v1/features/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"archived\": true,\n  \"project\": \"<string>\",\n  \"targetingAllProjects\": true,\n  \"targetingProjects\": [\n    \"<string>\"\n  ],\n  \"owner\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"baseConfig\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"environments\": {},\n  \"prerequisites\": [\n    \"<string>\"\n  ],\n  \"jsonSchema\": \"<string>\",\n  \"customFields\": {},\n  \"holdout\": {\n    \"id\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"ignoreWarnings\": true,\n  \"skipSchemaValidation\": true,\n  \"skipHooks\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growthbook.io/api/v1/features/{id}")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"archived\": true,\n  \"project\": \"<string>\",\n  \"targetingAllProjects\": true,\n  \"targetingProjects\": [\n    \"<string>\"\n  ],\n  \"owner\": \"<string>\",\n  \"defaultValue\": \"<string>\",\n  \"baseConfig\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"environments\": {},\n  \"prerequisites\": [\n    \"<string>\"\n  ],\n  \"jsonSchema\": \"<string>\",\n  \"customFields\": {},\n  \"holdout\": {\n    \"id\": \"<string>\",\n    \"value\": \"<string>\"\n  },\n  \"ignoreWarnings\": true,\n  \"skipSchemaValidation\": true,\n  \"skipHooks\": true\n}"

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

{
  "feature": {
    "id": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "archived": true,
    "description": "<string>",
    "owner": "<string>",
    "project": "<string>",
    "valueType": "boolean",
    "defaultValue": "<string>",
    "tags": [
      "<string>"
    ],
    "environments": {},
    "revision": {
      "version": 123,
      "comment": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "publishedBy": "<string>",
      "id": "<string>"
    },
    "ownerEmail": "<string>",
    "targetingAllProjects": true,
    "targetingProjects": [
      "<string>"
    ],
    "baseConfig": "<string>",
    "defaultValueConfig": "<string>",
    "prerequisites": [
      "<string>"
    ],
    "customFields": {},
    "holdout": {
      "id": "<string>",
      "value": "<string>"
    }
  },
  "bypassedGates": [
    {
      "type": "<string>",
      "outcome": "bypassed",
      "via": "ignoreWarnings"
    }
  ]
}

Introduction

Endpoints

Models

Authorizations

Path Parameters

Body

Response