Update a custom-field definition

Warning: If you send fieldOptions, it is a full replacement of the
options. Every existing option whose numeric ID you leave out is permanently
deleted, and [] removes all options. To keep the options unchanged, omit
fieldOptions or send null. Options with a null or unknown ID are created.

displayLabel is required; fieldName and fieldKey cannot change. Include
the existing objectTypes: if you omit it, it defaults to [] and clears the
scope. Other nullable properties keep their values when null or omitted; you
can set empty tooltipDescription or defaultValue strings.

You can change fieldType even when the field is in use, but existing values
may become invalid. This update does not check the URL default as create
does. Requires the CustomField:Update permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Admin definition ID (int64). The route accepts digits only.

Body Params
string
enum

Definition types. Test-case values support six types, not TAG or URL.

objectTypes
array of strings
Defaults to []

Omission clears scope; include existing values to preserve.

objectTypes
string
required
length between 1 and 50

Required nonblank label.

string | null
boolean | null
boolean | null
boolean | null
boolean | null
boolean | null
string | null
fieldOptions
array of objects | null

Supplied array replaces options; omitted/null preserves.

fieldOptions
Headers
uuid
required

Required resolved account UUID; no default. Does not grant permission or override ownership.

int64
required

Project ID, required on every request. It selects the project context; it is not a record ID and does not grant permissions.

int64

Optional numeric organization context; does not grant membership or permission.

Responses

400

Invalid payload, context, or ID; an ownership or lifecycle restriction; a capacity limit; or a TrueTest failure. The error body format varies.

401

Authentication or the required user context is missing or invalid. The error body format varies.

403

The caller lacks the operation permission or access to the resource. Headers do not grant access. The error body format varies.

default

Any other error. The error body format varies.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json