Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

field
string
required

Body

application/json

A change to an item custom field; its key comes from the route and never changes.

label
string
required
Maximum string length: 100
type
enum<string>
required

What a custom field holds.

Available options:
text,
number,
date,
boolean,
select
classification
enum<string>
required

How sensitive a custom field's values are. Confidential values are encrypted under the organization's key, shown only to those who may see confidential records, and cannot be filtered on.

Available options:
internal,
confidential
options
string[] | null
Maximum array length: 50
Maximum string length: 100
required
boolean

Response

CustomFieldResource

data
CustomFieldResource · object
required