Custom Field Definitions
Create a custom field definition
Creates a custom field definition. Once created, key, value_type, and object_type are immutable. Values are set on the parent record — custom_field_values on assets, field_values on projects.
POST
/
custom_field_definitions
Create a custom field definition
curl --request POST \
--url https://app.gomangrove.com/api/v1/custom_field_definitions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"custom_field_definition": {
"label": "Status",
"value_type": "enum",
"object_type": "asset",
"enumeration_options": [
"Unregistered",
"Registered",
"Inactive"
]
}
}
'import requests
url = "https://app.gomangrove.com/api/v1/custom_field_definitions"
payload = { "custom_field_definition": {
"label": "Status",
"value_type": "enum",
"object_type": "asset",
"enumeration_options": ["Unregistered", "Registered", "Inactive"]
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
custom_field_definition: {
label: 'Status',
value_type: 'enum',
object_type: 'asset',
enumeration_options: ['Unregistered', 'Registered', 'Inactive']
}
})
};
fetch('https://app.gomangrove.com/api/v1/custom_field_definitions', 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://app.gomangrove.com/api/v1/custom_field_definitions",
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([
'custom_field_definition' => [
'label' => 'Status',
'value_type' => 'enum',
'object_type' => 'asset',
'enumeration_options' => [
'Unregistered',
'Registered',
'Inactive'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://app.gomangrove.com/api/v1/custom_field_definitions"
payload := strings.NewReader("{\n \"custom_field_definition\": {\n \"label\": \"Status\",\n \"value_type\": \"enum\",\n \"object_type\": \"asset\",\n \"enumeration_options\": [\n \"Unregistered\",\n \"Registered\",\n \"Inactive\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://app.gomangrove.com/api/v1/custom_field_definitions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"custom_field_definition\": {\n \"label\": \"Status\",\n \"value_type\": \"enum\",\n \"object_type\": \"asset\",\n \"enumeration_options\": [\n \"Unregistered\",\n \"Registered\",\n \"Inactive\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gomangrove.com/api/v1/custom_field_definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"custom_field_definition\": {\n \"label\": \"Status\",\n \"value_type\": \"enum\",\n \"object_type\": \"asset\",\n \"enumeration_options\": [\n \"Unregistered\",\n \"Registered\",\n \"Inactive\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 43,
"friendly_id": "cfd_def456abc123",
"key": "status",
"label": "Status",
"object_type": "asset",
"value_type": "enum",
"enumeration_options": [
"Unregistered",
"Registered",
"Inactive"
],
"order": 2,
"is_required": false,
"project_id": null,
"created_at": "2026-01-15T10:00:00.000Z",
"updated_at": "2026-01-15T10:00:00.000Z"
}{
"status": "error",
"statusCode": 422,
"errors": [
{
"message": "Label has already been taken"
}
]
}Previous
Update a custom field definitionUpdates a custom field definition. `key`, `value_type`, and `object_type` are immutable. For enum definitions, `enumeration_options` replaces the full list — include existing options you want to keep. A project-scoped definition can be widened to account-wide by clearing `project_id`; narrowing is not supported.
Next
⌘I
Create a custom field definition
curl --request POST \
--url https://app.gomangrove.com/api/v1/custom_field_definitions \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"custom_field_definition": {
"label": "Status",
"value_type": "enum",
"object_type": "asset",
"enumeration_options": [
"Unregistered",
"Registered",
"Inactive"
]
}
}
'import requests
url = "https://app.gomangrove.com/api/v1/custom_field_definitions"
payload = { "custom_field_definition": {
"label": "Status",
"value_type": "enum",
"object_type": "asset",
"enumeration_options": ["Unregistered", "Registered", "Inactive"]
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
custom_field_definition: {
label: 'Status',
value_type: 'enum',
object_type: 'asset',
enumeration_options: ['Unregistered', 'Registered', 'Inactive']
}
})
};
fetch('https://app.gomangrove.com/api/v1/custom_field_definitions', 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://app.gomangrove.com/api/v1/custom_field_definitions",
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([
'custom_field_definition' => [
'label' => 'Status',
'value_type' => 'enum',
'object_type' => 'asset',
'enumeration_options' => [
'Unregistered',
'Registered',
'Inactive'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://app.gomangrove.com/api/v1/custom_field_definitions"
payload := strings.NewReader("{\n \"custom_field_definition\": {\n \"label\": \"Status\",\n \"value_type\": \"enum\",\n \"object_type\": \"asset\",\n \"enumeration_options\": [\n \"Unregistered\",\n \"Registered\",\n \"Inactive\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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://app.gomangrove.com/api/v1/custom_field_definitions")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"custom_field_definition\": {\n \"label\": \"Status\",\n \"value_type\": \"enum\",\n \"object_type\": \"asset\",\n \"enumeration_options\": [\n \"Unregistered\",\n \"Registered\",\n \"Inactive\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gomangrove.com/api/v1/custom_field_definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"custom_field_definition\": {\n \"label\": \"Status\",\n \"value_type\": \"enum\",\n \"object_type\": \"asset\",\n \"enumeration_options\": [\n \"Unregistered\",\n \"Registered\",\n \"Inactive\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 43,
"friendly_id": "cfd_def456abc123",
"key": "status",
"label": "Status",
"object_type": "asset",
"value_type": "enum",
"enumeration_options": [
"Unregistered",
"Registered",
"Inactive"
],
"order": 2,
"is_required": false,
"project_id": null,
"created_at": "2026-01-15T10:00:00.000Z",
"updated_at": "2026-01-15T10:00:00.000Z"
}{
"status": "error",
"statusCode": 422,
"errors": [
{
"message": "Label has already been taken"
}
]
}