Skip to main content
PUT
/
custom_fields
/
{id}
/
values
/
{record_id}
Upsert a custom-field value
curl --request PUT \
  --url https://api.arcuserp.com/v1/custom_fields/{id}/values/{record_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parent_type": "<string>",
  "value": "<string>"
}
'
import requests

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

payload = {
"parent_type": "<string>",
"value": "<string>"
}
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({parent_type: '<string>', value: '<string>'})
};

fetch('https://api.arcuserp.com/v1/custom_fields/{id}/values/{record_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}/values/{record_id}",
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([
'parent_type' => '<string>',
'value' => '<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.arcuserp.com/v1/custom_fields/{id}/values/{record_id}"

payload := strings.NewReader("{\n \"parent_type\": \"<string>\",\n \"value\": \"<string>\"\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.arcuserp.com/v1/custom_fields/{id}/values/{record_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"parent_type\": \"<string>\",\n \"value\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"parent_type\": \"<string>\",\n \"value\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "custom_field_value",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "custom_field_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parent_type": "<string>",
  "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "value_text": "<string>",
  "value_number": 123,
  "value_date": "2023-12-25",
  "value_datetime": "2023-11-07T05:31:56Z",
  "value_boolean": true,
  "value_json": {},
  "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.

Path Parameters

id
string<uuid>
required

CustomField id.

record_id
string<uuid>
required

Parent resource record id.

Body

application/json
parent_type
string
required

Mirrors CustomField.parent_type.

value
required

Coerced into the matching value_* column per CustomField.field_type.

Response

Upserted value

A custom-field value attached to a parent record (parent_type + parent_id). Exactly ONE of value_text / value_number / value_date / value_datetime / value_boolean / value_json is populated based on the parent CustomField.field_type. Scope: custom_fields:read / custom_fields:write.

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

"custom_field_value"

entity_id
string<uuid>
read-only
custom_field_id
string<uuid>
parent_type
string

Mirrors CustomField.parent_type.

parent_id
string<uuid>

Id of the parent resource record.

value_text
string | null
value_number
number<float> | null
value_date
string<date> | null
value_datetime
string<date-time> | null
value_boolean
boolean | null
value_json
object | null
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only