Update revision metadata (comment, title, feature metadata)
deprecated
Deprecated. Use PUT /v2/features/:id/revisions/:version/metadata instead.
Updates draft-level metadata (comment, title) and/or feature-level metadata (owner, project, tags, customFields, jsonSchema, etc.). Merge semantics: omitted fields are left unchanged; any provided field replaces the current value (pass an empty string/array/object to clear). Feature metadata changes are staged on the revision and applied to the feature on publish. Changing project requires publish permission on both the old and new project.
PUT
/
v1
/
features
/
{id}
/
revisions
/
{version}
/
metadata
cURL
curl -X PUT 'https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/metadata' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/metadata"
payload = {
"comment": "<string>",
"title": "<string>",
"description": "<string>",
"owner": "<string>",
"project": "<string>",
"tags": ["<string>"],
"neverStale": True,
"customFields": {},
"ignoreWarnings": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
comment: '<string>',
title: '<string>',
description: '<string>',
owner: '<string>',
project: '<string>',
tags: ['<string>'],
neverStale: true,
customFields: {},
ignoreWarnings: true
})
};
fetch('https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/metadata', 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}/revisions/{version}/metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'comment' => '<string>',
'title' => '<string>',
'description' => '<string>',
'owner' => '<string>',
'project' => '<string>',
'tags' => [
'<string>'
],
'neverStale' => true,
'customFields' => [
],
'ignoreWarnings' => 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}/revisions/{version}/metadata"
payload := strings.NewReader("{\n \"comment\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"neverStale\": true,\n \"customFields\": {},\n \"ignoreWarnings\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/metadata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"comment\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"neverStale\": true,\n \"customFields\": {},\n \"ignoreWarnings\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"comment\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"neverStale\": true,\n \"customFields\": {},\n \"ignoreWarnings\": true\n}"
response = http.request(request)
puts response.read_body{
"revision": {
"id": "<string>",
"featureId": "<string>",
"baseVersion": 123,
"version": 123,
"comment": "<string>",
"date": "2023-11-07T05:31:56Z",
"status": "<string>",
"rules": {},
"createdBy": "<string>",
"publishedBy": "<string>",
"defaultValue": "<string>",
"definitions": {},
"environmentsEnabled": {},
"envPrerequisites": {},
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"metadata": {
"description": "<string>",
"owner": "<string>",
"project": "<string>",
"tags": [
"<string>"
],
"neverStale": true,
"valueType": "<string>",
"jsonSchema": {
"schemaType": "schema",
"schema": "<string>",
"simple": {},
"date": "2023-11-07T05:31:56Z",
"enabled": true
},
"customFields": {},
"baseConfig": "<string>"
},
"rampActions": [
{
"mode": "create",
"ruleId": "<string>",
"name": "<string>",
"environment": "<string>",
"templateId": "<string>",
"startActions": [
{
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"ids": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": true,
"environments": [
"<string>"
],
"force": "<unknown>",
"enabled": true
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"steps": [
{
"interval": 1,
"actions": [
{
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"ids": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": true,
"environments": [
"<string>"
],
"force": "<unknown>",
"enabled": true
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"approvalNotes": "<string>",
"monitored": true,
"holdConditions": {
"minSampleSize": 123,
"requiresApproval": true
}
}
],
"endActions": [
{
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"ids": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": true,
"environments": [
"<string>"
],
"force": "<unknown>",
"enabled": true
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"startDate": "2023-11-07T05:31:56Z",
"cutoffDate": "2023-11-07T05:31:56Z",
"monitoringConfig": {
"datasourceId": "<string>",
"exposureQueryId": "<string>",
"guardrailMetricIds": [
"<string>"
],
"signalMetricIds": [
"<string>"
],
"updateScheduleMinutes": 11,
"monitoringMode": "auto",
"autoUpdate": true,
"srmAction": "rollback",
"noTrafficAction": "rollback",
"noTrafficGracePeriodHours": 1,
"multipleExposureAction": "rollback"
},
"lockdownConfig": {
"mode": "none"
},
"requiresStartApproval": true
}
]
}
}Authorizations
bearerAuthbasicAuth
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
application/json
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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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.
Response
200 - application/json
Resource updated
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl -X PUT 'https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/metadata' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/metadata"
payload = {
"comment": "<string>",
"title": "<string>",
"description": "<string>",
"owner": "<string>",
"project": "<string>",
"tags": ["<string>"],
"neverStale": True,
"customFields": {},
"ignoreWarnings": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
comment: '<string>',
title: '<string>',
description: '<string>',
owner: '<string>',
project: '<string>',
tags: ['<string>'],
neverStale: true,
customFields: {},
ignoreWarnings: true
})
};
fetch('https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/metadata', 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}/revisions/{version}/metadata",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'comment' => '<string>',
'title' => '<string>',
'description' => '<string>',
'owner' => '<string>',
'project' => '<string>',
'tags' => [
'<string>'
],
'neverStale' => true,
'customFields' => [
],
'ignoreWarnings' => 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}/revisions/{version}/metadata"
payload := strings.NewReader("{\n \"comment\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"neverStale\": true,\n \"customFields\": {},\n \"ignoreWarnings\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/metadata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"comment\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"neverStale\": true,\n \"customFields\": {},\n \"ignoreWarnings\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/features/{id}/revisions/{version}/metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"comment\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"project\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"neverStale\": true,\n \"customFields\": {},\n \"ignoreWarnings\": true\n}"
response = http.request(request)
puts response.read_body{
"revision": {
"id": "<string>",
"featureId": "<string>",
"baseVersion": 123,
"version": 123,
"comment": "<string>",
"date": "2023-11-07T05:31:56Z",
"status": "<string>",
"rules": {},
"createdBy": "<string>",
"publishedBy": "<string>",
"defaultValue": "<string>",
"definitions": {},
"environmentsEnabled": {},
"envPrerequisites": {},
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"metadata": {
"description": "<string>",
"owner": "<string>",
"project": "<string>",
"tags": [
"<string>"
],
"neverStale": true,
"valueType": "<string>",
"jsonSchema": {
"schemaType": "schema",
"schema": "<string>",
"simple": {},
"date": "2023-11-07T05:31:56Z",
"enabled": true
},
"customFields": {},
"baseConfig": "<string>"
},
"rampActions": [
{
"mode": "create",
"ruleId": "<string>",
"name": "<string>",
"environment": "<string>",
"templateId": "<string>",
"startActions": [
{
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"ids": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": true,
"environments": [
"<string>"
],
"force": "<unknown>",
"enabled": true
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"steps": [
{
"interval": 1,
"actions": [
{
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"ids": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": true,
"environments": [
"<string>"
],
"force": "<unknown>",
"enabled": true
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"approvalNotes": "<string>",
"monitored": true,
"holdConditions": {
"minSampleSize": 123,
"requiresApproval": true
}
}
],
"endActions": [
{
"patch": {
"ruleId": "<string>",
"coverage": 0.5,
"condition": "<string>",
"savedGroups": [
{
"match": "all",
"ids": [
"<string>"
]
}
],
"prerequisites": [
{
"id": "<string>",
"condition": "<string>"
}
],
"allEnvironments": true,
"environments": [
"<string>"
],
"force": "<unknown>",
"enabled": true
},
"targetType": "feature-rule",
"targetId": "<string>"
}
],
"startDate": "2023-11-07T05:31:56Z",
"cutoffDate": "2023-11-07T05:31:56Z",
"monitoringConfig": {
"datasourceId": "<string>",
"exposureQueryId": "<string>",
"guardrailMetricIds": [
"<string>"
],
"signalMetricIds": [
"<string>"
],
"updateScheduleMinutes": 11,
"monitoringMode": "auto",
"autoUpdate": true,
"srmAction": "rollback",
"noTrafficAction": "rollback",
"noTrafficGracePeriodHours": 1,
"multipleExposureAction": "rollback"
},
"lockdownConfig": {
"mode": "none"
},
"requiresStartApproval": true
}
]
}
}