Skip to main content
PATCH
Partial Update Custom Field

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Body

name
string
Maximum string length: 100
label
string
Maximum string length: 100
field_type
enum<string>
  • text - Free Text
  • single_select - Single Select
  • date - Date
  • number - Number
  • boolean - Boolean
Available options:
text,
single_select,
date,
number,
boolean
options
any
is_required
boolean
display_order
integer
Required range: -2147483648 <= x <= 2147483647
is_active
boolean
include_on_invoice
boolean

Response

200 - application/json
id
integer
required
read-only
app
string
required
read-only
model
string
required
read-only
name
string
required
Maximum string length: 100
label
string
required
Maximum string length: 100
field_type
enum<string>
required
  • text - Free Text
  • single_select - Single Select
  • date - Date
  • number - Number
  • boolean - Boolean
Available options:
text,
single_select,
date,
number,
boolean
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
is_deleted
boolean
default:false
required
read-only
deleted_at
string<date-time> | null
required
read-only
options
any
is_required
boolean
display_order
integer
Required range: -2147483648 <= x <= 2147483647
is_active
boolean
include_on_invoice
boolean