Create a custom field definition

Defines a new custom field on a parent resource type. field_key must be unique per (entity, parent_type). Idempotent on Idempotency-Key. Requires the custom_fields:write scope.

POST /custom_fields

Create a custom field definition

cURL

curl --request POST \
  --url https://api.arcuserp.com/v1/custom_fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parent_type": "<string>",
  "field_key": "<string>",
  "label": "<string>",
  "required": false,
  "options": [
    "<string>"
  ],
  "default_value": "<string>",
  "help_text": "<string>",
  "display_order": 0,
  "metadata": {}
}
'

201

{
  "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"
}

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

Body

application/json

parent_type · string · required

1..30 chars.

field_key · string · required

1..80 chars. Stable identifier.

label · string · required

1..150 chars.

field_type · enum<string> · required

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

required · boolean · default: false

options · string[] | null

default_value · string | null

help_text · string | null

display_order · integer · default: 0

metadata · object | null

Response

201

application/json

Created 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