Create a single feature
Deprecated. Use POST /v2/features instead.
curl -X POST 'https://api.growthbook.io/api/v1/features' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/features"
payload = {
"id": "<string>",
"defaultValue": "<string>",
"archived": True,
"description": "<string>",
"owner": "<string>",
"project": "<string>",
"targetingAllProjects": True,
"targetingProjects": ["<string>"],
"baseConfig": "<string>",
"tags": ["<string>"],
"environments": {},
"prerequisites": ["<string>"],
"jsonSchema": "<string>",
"customFields": {},
"comment": "<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({
id: '<string>',
defaultValue: '<string>',
archived: true,
description: '<string>',
owner: '<string>',
project: '<string>',
targetingAllProjects: true,
targetingProjects: ['<string>'],
baseConfig: '<string>',
tags: ['<string>'],
environments: {},
prerequisites: ['<string>'],
jsonSchema: '<string>',
customFields: {},
comment: '<string>',
ignoreWarnings: true,
skipSchemaValidation: true,
skipHooks: true
})
};
fetch('https://api.growthbook.io/api/v1/features', 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",
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([
'id' => '<string>',
'defaultValue' => '<string>',
'archived' => true,
'description' => '<string>',
'owner' => '<string>',
'project' => '<string>',
'targetingAllProjects' => true,
'targetingProjects' => [
'<string>'
],
'baseConfig' => '<string>',
'tags' => [
'<string>'
],
'environments' => [
],
'prerequisites' => [
'<string>'
],
'jsonSchema' => '<string>',
'customFields' => [
],
'comment' => '<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"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"archived\": true,\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"targetingAllProjects\": true,\n \"targetingProjects\": [\n \"<string>\"\n ],\n \"baseConfig\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"environments\": {},\n \"prerequisites\": [\n \"<string>\"\n ],\n \"jsonSchema\": \"<string>\",\n \"customFields\": {},\n \"comment\": \"<string>\",\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"archived\": true,\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"targetingAllProjects\": true,\n \"targetingProjects\": [\n \"<string>\"\n ],\n \"baseConfig\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"environments\": {},\n \"prerequisites\": [\n \"<string>\"\n ],\n \"jsonSchema\": \"<string>\",\n \"customFields\": {},\n \"comment\": \"<string>\",\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")
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 \"id\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"archived\": true,\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"targetingAllProjects\": true,\n \"targetingProjects\": [\n \"<string>\"\n ],\n \"baseConfig\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"environments\": {},\n \"prerequisites\": [\n \"<string>\"\n ],\n \"jsonSchema\": \"<string>\",\n \"customFields\": {},\n \"comment\": \"<string>\",\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>"
}
}
}{
"confirmation": {
"id": "<string>",
"status": "pending",
"actions": [
{
"action": "feature.create",
"environments": [
"<string>"
]
}
],
"summary": "<string>",
"url": "<string>",
"expiresAt": "<string>",
"response": {
"status": 123,
"body": "<unknown>"
},
"note": "<string>"
},
"message": "<string>"
}Authorizations
If using Bearer auth, pass the Secret Key as the token:
curl https://api.growthbook.io/api/v1/features -H "Authorization: Bearer secret_abc123DEF456"
Body
Unique, permanent key, shown as the Feature Flag's name in the UI and used in code. Keep it short. If featureRegexValidator in GET /api/v1/settings is set, follow it (featureKeyExample shows the format); otherwise use kebab-case (e.g. checkout-express-pay). Put context in description.
1^[a-zA-Z0-9_.:\|\-]+$The data type of the feature payload. Boolean by default.
boolean, string, number, json Default value when feature is enabled. Type must match valueType. In Config mode (baseConfig set) this is the JSON override patch merged on top of the config.
Markdown. What the Feature Flag gates and why, rollout plan, and links. Put context here, not in the key.
10000The 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. When omitted, it defaults to the requesting member: a personal access token's owner, or the member an organization API key assumes. An organization API key acting as itself must send it, or the request fails with a 400.
An associated project ID
Make this feature discoverable in — and served to — every project, beyond its primary project. Requires the targetFeatures permission (FlagsTarget policy) unscoped to any project. Governance stays with project.
Secondary project IDs this feature is targeted in and served to, beyond its primary project. Adding a project requires the targetFeatures permission (FlagsTarget policy) in that project. Governance stays with project.
Key of the config backing this flag ("Config mode"). Requires valueType: "json" and a live config; defaultValue and rule values become override patches on top. null or omitted for a plain flag.
Tags for filtering and grouping. Use these instead of encoding groups in names.
Settings for each environment, keyed by environment ID. Any environment you leave out is enabled or disabled per that environment's "Default state for new features" setting.
Show child attributes
Show child attributes
Feature IDs. Each feature must evaluate to true
Use JSON schema to validate the payload of a JSON-type feature value (enterprise only).
Show child attributes
Show child attributes
Comment to record on the feature's initial revision. Defaults to an empty comment.
Set to true to acknowledge the warnings listed in a blocked response and continue. This covers experiment guards, locked dependents, and references affected by an archive. When the organization treats schema failures as warnings, it also covers schema and invariant warnings. It never bypasses a rejected Custom Hook. On revision publish endpoints, it can also force-publish an out-of-date draft when the caller has Bypass draft approvals access. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.
Set to true to publish despite schema validation errors, failed invariants, or schema changes that invalidate dependent resources. This does not bypass a rejected Custom Hook; use skipHooks for that. The caller must have Bypass draft approvals access for Feature Flags, Configs, and Constants in every Project. Otherwise, this field is ignored. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.
Set to true to publish despite a Custom Hook rejection. This does not bypass schema validation; use skipSchemaValidation for that. The caller must have Bypass draft approvals access for Feature Flags, Configs, and Constants in every Project. Otherwise, this field is ignored. Only set this when a person has explicitly asked you to. If a check blocks you, stop and ask a person instead of working around it.
Response
Resource created
Show child attributes
Show child attributes
Was this page helpful?
curl -X POST 'https://api.growthbook.io/api/v1/features' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/features"
payload = {
"id": "<string>",
"defaultValue": "<string>",
"archived": True,
"description": "<string>",
"owner": "<string>",
"project": "<string>",
"targetingAllProjects": True,
"targetingProjects": ["<string>"],
"baseConfig": "<string>",
"tags": ["<string>"],
"environments": {},
"prerequisites": ["<string>"],
"jsonSchema": "<string>",
"customFields": {},
"comment": "<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({
id: '<string>',
defaultValue: '<string>',
archived: true,
description: '<string>',
owner: '<string>',
project: '<string>',
targetingAllProjects: true,
targetingProjects: ['<string>'],
baseConfig: '<string>',
tags: ['<string>'],
environments: {},
prerequisites: ['<string>'],
jsonSchema: '<string>',
customFields: {},
comment: '<string>',
ignoreWarnings: true,
skipSchemaValidation: true,
skipHooks: true
})
};
fetch('https://api.growthbook.io/api/v1/features', 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",
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([
'id' => '<string>',
'defaultValue' => '<string>',
'archived' => true,
'description' => '<string>',
'owner' => '<string>',
'project' => '<string>',
'targetingAllProjects' => true,
'targetingProjects' => [
'<string>'
],
'baseConfig' => '<string>',
'tags' => [
'<string>'
],
'environments' => [
],
'prerequisites' => [
'<string>'
],
'jsonSchema' => '<string>',
'customFields' => [
],
'comment' => '<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"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"archived\": true,\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"targetingAllProjects\": true,\n \"targetingProjects\": [\n \"<string>\"\n ],\n \"baseConfig\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"environments\": {},\n \"prerequisites\": [\n \"<string>\"\n ],\n \"jsonSchema\": \"<string>\",\n \"customFields\": {},\n \"comment\": \"<string>\",\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"archived\": true,\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"targetingAllProjects\": true,\n \"targetingProjects\": [\n \"<string>\"\n ],\n \"baseConfig\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"environments\": {},\n \"prerequisites\": [\n \"<string>\"\n ],\n \"jsonSchema\": \"<string>\",\n \"customFields\": {},\n \"comment\": \"<string>\",\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")
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 \"id\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"archived\": true,\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"targetingAllProjects\": true,\n \"targetingProjects\": [\n \"<string>\"\n ],\n \"baseConfig\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"environments\": {},\n \"prerequisites\": [\n \"<string>\"\n ],\n \"jsonSchema\": \"<string>\",\n \"customFields\": {},\n \"comment\": \"<string>\",\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>"
}
}
}{
"confirmation": {
"id": "<string>",
"status": "pending",
"actions": [
{
"action": "feature.create",
"environments": [
"<string>"
]
}
],
"summary": "<string>",
"url": "<string>",
"expiresAt": "<string>",
"response": {
"status": 123,
"body": "<unknown>"
},
"note": "<string>"
},
"message": "<string>"
}