Skip to main content
PATCH
/
custom_fields
/
{id}
Update a custom field definition
curl --request PATCH \
  --url https://api.arcuserp.com/v1/custom_fields/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "required": true,
  "options": [
    "<string>"
  ],
  "default_value": "<string>",
  "help_text": "<string>",
  "display_order": 123,
  "is_active": true,
  "metadata": {}
}
'
import requests

url = "https://api.arcuserp.com/v1/custom_fields/{id}"

payload = {
"label": "<string>",
"required": True,
"options": ["<string>"],
"default_value": "<string>",
"help_text": "<string>",
"display_order": 123,
"is_active": True,
"metadata": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
label: '<string>',
required: true,
options: ['<string>'],
default_value: '<string>',
help_text: '<string>',
display_order: 123,
is_active: true,
metadata: {}
})
};

fetch('https://api.arcuserp.com/v1/custom_fields/{id}', 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.arcuserp.com/v1/custom_fields/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'label' => '<string>',
'required' => true,
'options' => [
'<string>'
],
'default_value' => '<string>',
'help_text' => '<string>',
'display_order' => 123,
'is_active' => true,
'metadata' => [

]
]),
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.arcuserp.com/v1/custom_fields/{id}"

payload := strings.NewReader("{\n \"label\": \"<string>\",\n \"required\": true,\n \"options\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"help_text\": \"<string>\",\n \"display_order\": 123,\n \"is_active\": true,\n \"metadata\": {}\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.arcuserp.com/v1/custom_fields/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"label\": \"<string>\",\n \"required\": true,\n \"options\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"help_text\": \"<string>\",\n \"display_order\": 123,\n \"is_active\": true,\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/custom_fields/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"label\": \"<string>\",\n \"required\": true,\n \"options\": [\n \"<string>\"\n ],\n \"default_value\": \"<string>\",\n \"help_text\": \"<string>\",\n \"display_order\": 123,\n \"is_active\": true,\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "custom_field",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_type": "account",
  "field_key": "tax_id_secondary",
  "label": "Secondary Tax ID",
  "field_type": "text",
  "required": false,
  "options": [
    "<string>"
  ],
  "default_value": "<string>",
  "help_text": "<string>",
  "display_order": 0,
  "is_active": true,
  "metadata": {},
  "deleted_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Alias for the Idempotency parameter. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

Body

application/json
label
string
required
boolean
options
string[] | null
default_value
string | null
help_text
string | null
display_order
integer
is_active
boolean
metadata
object

Response

Updated custom field

A user-defined custom field attached to a parent resource type (parent_type is one of: account, product, order, vendor_bill, etc.). Values are stored separately in entity_custom_field_values and read/ written via the /custom_fields/{parent_type}/{parent_id}/values and /custom_fields/{custom_field_id}/values/{parent_id} endpoints. Scope: custom_fields:read / custom_fields:write / custom_fields:delete.

id
string<uuid>
read-only
object
string
Example:

"custom_field"

entity_id
string<uuid>
read-only
parent_type
string

Parent resource type this field attaches to. 1..30 chars.

Example:

"account"

field_key
string

Stable machine identifier. 1..80 chars. Unique per (entity, parent_type).

Example:

"tax_id_secondary"

label
string

Human-readable label rendered in UI. 1..150 chars.

Example:

"Secondary Tax ID"

field_type
enum<string>

Storage type. Drives which value_* column is written in entity_custom_field_values.

Available options:
text,
number,
date,
datetime,
boolean,
json,
select,
multiselect
Example:

"text"

required
boolean
default:false
options
string[] | null

For select / multiselect field_type only.

default_value
string | null
help_text
string | null
display_order
integer
default:0
is_active
boolean
default:true
metadata
object

Free-form caller metadata. Default {}.

deleted_at
string<date-time> | null
read-only

Set by softDelete; cleared by restore.

created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only