Update a custom field
CustomFields
Update a custom field
Update label, applyTo (widen-only), optionsToAdd, or optionsToRename on a custom field. At least one field must be provided. Archived fields cannot be updated.
PATCH
Update a custom field
Key: Write
Scope: Company
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Path Parameters
Body
application/json
New display label.
Required string length:
1 - 120Entity types this field applies to (widen-only).
Minimum array length:
1Available options:
DEVICE, ACCESSORY, EMPLOYEE, ORDER New option values to append. Only valid for SELECT / MULTI_SELECT fields.
Minimum array length:
1Required string length:
1 - 120Existing options to rename, referenced by their stable option id.
Minimum array length:
1Response
default - application/json
Available options:
SELECT, MULTI_SELECT, CHECKBOX, TEXT, DATE, NUMBER, URL Available options:
DEVICE, ACCESSORY, EMPLOYEE, ORDER Available options:
ACTIVE, ARCHIVED Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$