Custom Fields
Create custom field (v1)
Create a new custom field definition.
POST
/
public
/
v1
/
custom-fields
/
Create custom field
curl --request POST \
--url https://api.dualentry.com/public/v1/custom-fields/ \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"applies_to": [
{
"is_active": true,
"is_required": false
}
],
"description": "<string>",
"helper_text": "<string>",
"default_value": "<string>",
"company_id": 123,
"company_ids": [
123
],
"is_active": true,
"options": [
"<string>"
]
}
'import requests
url = "https://api.dualentry.com/public/v1/custom-fields/"
payload = {
"name": "<string>",
"applies_to": [
{
"is_active": True,
"is_required": False
}
],
"description": "<string>",
"helper_text": "<string>",
"default_value": "<string>",
"company_id": 123,
"company_ids": [123],
"is_active": True,
"options": ["<string>"]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
applies_to: [{is_active: true, is_required: false}],
description: '<string>',
helper_text: '<string>',
default_value: '<string>',
company_id: 123,
company_ids: [123],
is_active: true,
options: ['<string>']
})
};
fetch('https://api.dualentry.com/public/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.dualentry.com/public/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([
'name' => '<string>',
'applies_to' => [
[
'is_active' => true,
'is_required' => false
]
],
'description' => '<string>',
'helper_text' => '<string>',
'default_value' => '<string>',
'company_id' => 123,
'company_ids' => [
123
],
'is_active' => true,
'options' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.dualentry.com/public/v1/custom-fields/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"applies_to\": [\n {\n \"is_active\": true,\n \"is_required\": false\n }\n ],\n \"description\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"default_value\": \"<string>\",\n \"company_id\": 123,\n \"company_ids\": [\n 123\n ],\n \"is_active\": true,\n \"options\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<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://api.dualentry.com/public/v1/custom-fields/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"applies_to\": [\n {\n \"is_active\": true,\n \"is_required\": false\n }\n ],\n \"description\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"default_value\": \"<string>\",\n \"company_id\": 123,\n \"company_ids\": [\n 123\n ],\n \"is_active\": true,\n \"options\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dualentry.com/public/v1/custom-fields/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"applies_to\": [\n {\n \"is_active\": true,\n \"is_required\": false\n }\n ],\n \"description\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"default_value\": \"<string>\",\n \"company_id\": 123,\n \"company_ids\": [\n 123\n ],\n \"is_active\": true,\n \"options\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"is_active": true,
"company_id": 123,
"company_ids": [],
"description": "<string>",
"helper_text": "<string>",
"applies_to": [],
"default_value": "<string>",
"options": [
"<string>"
]
}{
"errors": {},
"success": false
}{
"errors": {},
"success": false
}{
"errors": {},
"success": false
}Authorizations
Body
application/json
Required string length:
2 - 32Available options:
text, number, currency, date, boolean, single_select, multi_select, link, paragraph Show child attributes
Show child attributes
Single company id this custom field is scoped to (merged into company_ids). Omit for an org-wide field.
List of company ids this custom field is scoped to. Omit for an org-wide field.
Allowed values for single_select / multi_select fields
Response
Created
Available options:
text, number, currency, date, boolean, single_select, multi_select, link, paragraph Show child attributes
Show child attributes
Last modified on July 13, 2026
Was this page helpful?
⌘I
Create custom field
curl --request POST \
--url https://api.dualentry.com/public/v1/custom-fields/ \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"name": "<string>",
"applies_to": [
{
"is_active": true,
"is_required": false
}
],
"description": "<string>",
"helper_text": "<string>",
"default_value": "<string>",
"company_id": 123,
"company_ids": [
123
],
"is_active": true,
"options": [
"<string>"
]
}
'import requests
url = "https://api.dualentry.com/public/v1/custom-fields/"
payload = {
"name": "<string>",
"applies_to": [
{
"is_active": True,
"is_required": False
}
],
"description": "<string>",
"helper_text": "<string>",
"default_value": "<string>",
"company_id": 123,
"company_ids": [123],
"is_active": True,
"options": ["<string>"]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
applies_to: [{is_active: true, is_required: false}],
description: '<string>',
helper_text: '<string>',
default_value: '<string>',
company_id: 123,
company_ids: [123],
is_active: true,
options: ['<string>']
})
};
fetch('https://api.dualentry.com/public/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.dualentry.com/public/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([
'name' => '<string>',
'applies_to' => [
[
'is_active' => true,
'is_required' => false
]
],
'description' => '<string>',
'helper_text' => '<string>',
'default_value' => '<string>',
'company_id' => 123,
'company_ids' => [
123
],
'is_active' => true,
'options' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.dualentry.com/public/v1/custom-fields/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"applies_to\": [\n {\n \"is_active\": true,\n \"is_required\": false\n }\n ],\n \"description\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"default_value\": \"<string>\",\n \"company_id\": 123,\n \"company_ids\": [\n 123\n ],\n \"is_active\": true,\n \"options\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<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://api.dualentry.com/public/v1/custom-fields/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"applies_to\": [\n {\n \"is_active\": true,\n \"is_required\": false\n }\n ],\n \"description\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"default_value\": \"<string>\",\n \"company_id\": 123,\n \"company_ids\": [\n 123\n ],\n \"is_active\": true,\n \"options\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dualentry.com/public/v1/custom-fields/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"applies_to\": [\n {\n \"is_active\": true,\n \"is_required\": false\n }\n ],\n \"description\": \"<string>\",\n \"helper_text\": \"<string>\",\n \"default_value\": \"<string>\",\n \"company_id\": 123,\n \"company_ids\": [\n 123\n ],\n \"is_active\": true,\n \"options\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"is_active": true,
"company_id": 123,
"company_ids": [],
"description": "<string>",
"helper_text": "<string>",
"applies_to": [],
"default_value": "<string>",
"options": [
"<string>"
]
}{
"errors": {},
"success": false
}{
"errors": {},
"success": false
}{
"errors": {},
"success": false
}