Create a single customField
POST
/
v1
/
custom-fields
cURL
curl -X POST 'https://api.growthbook.io/api/v1/custom-fields' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/custom-fields"
payload = {
"id": "<string>",
"name": "<string>",
"required": True,
"sections": [],
"description": "<string>",
"placeholder": "<string>",
"defaultValue": "<string>",
"values": "<string>",
"projects": ["<string>"]
}
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>',
name: '<string>',
required: true,
sections: [],
description: '<string>',
placeholder: '<string>',
defaultValue: '<string>',
values: '<string>',
projects: ['<string>']
})
};
fetch('https://api.growthbook.io/api/v1/custom-fields', 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/custom-fields",
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>',
'name' => '<string>',
'required' => true,
'sections' => [
],
'description' => '<string>',
'placeholder' => '<string>',
'defaultValue' => '<string>',
'values' => '<string>',
'projects' => [
'<string>'
]
]),
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/custom-fields"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"required\": true,\n \"sections\": [],\n \"description\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"values\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ]\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/custom-fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"required\": true,\n \"sections\": [],\n \"description\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"values\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/custom-fields")
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 \"name\": \"<string>\",\n \"required\": true,\n \"sections\": [],\n \"description\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"values\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"customField": {
"id": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"required": true,
"sections": [],
"description": "<string>",
"placeholder": "<string>",
"defaultValue": "<string>",
"values": "<string>",
"creator": "<string>",
"projects": [
"<string>"
],
"active": 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 unique key for the custom field
Minimum string length:
1The display name of the custom field
The type of value this custom field will take
Available options:
text, textarea, markdown, enum, multiselect, url, number, boolean, date, datetime What types of objects this custom field is applicable to (feature, experiment)
Available options:
feature, experiment defaultValue
stringnumberbooleanstring<date-time>string<date>string[]number[]boolean[]string<date-time>[]string<date>[]
Response
200 - application/json
Resource created
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl -X POST 'https://api.growthbook.io/api/v1/custom-fields' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/custom-fields"
payload = {
"id": "<string>",
"name": "<string>",
"required": True,
"sections": [],
"description": "<string>",
"placeholder": "<string>",
"defaultValue": "<string>",
"values": "<string>",
"projects": ["<string>"]
}
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>',
name: '<string>',
required: true,
sections: [],
description: '<string>',
placeholder: '<string>',
defaultValue: '<string>',
values: '<string>',
projects: ['<string>']
})
};
fetch('https://api.growthbook.io/api/v1/custom-fields', 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/custom-fields",
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>',
'name' => '<string>',
'required' => true,
'sections' => [
],
'description' => '<string>',
'placeholder' => '<string>',
'defaultValue' => '<string>',
'values' => '<string>',
'projects' => [
'<string>'
]
]),
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/custom-fields"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"required\": true,\n \"sections\": [],\n \"description\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"values\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ]\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/custom-fields")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"required\": true,\n \"sections\": [],\n \"description\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"values\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/custom-fields")
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 \"name\": \"<string>\",\n \"required\": true,\n \"sections\": [],\n \"description\": \"<string>\",\n \"placeholder\": \"<string>\",\n \"defaultValue\": \"<string>\",\n \"values\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"customField": {
"id": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"required": true,
"sections": [],
"description": "<string>",
"placeholder": "<string>",
"defaultValue": "<string>",
"values": "<string>",
"creator": "<string>",
"projects": [
"<string>"
],
"active": true
}
}
