Custom Field
Update Custom Field
WRITE
access to the ADMIN
module is required to access this endpointPUT
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
The id of the custom field to update
Body
application/json
Custom field object that needs to be updated
The default custom field schema
Name of the custom field
Example:
"Booking Type"
Description of the custom field, shown in the UI at the help icon
Example:
"Select the type of booking"
The type of the custom field
Available options:
text
, textarea
, select
Example:
"select"
The default custom field option schema
The module that this custom field is linked to
Available options:
booking
, project
, people
, organization
, quote
, invoice
, quote_invoice
, billable_item
Example:
"booking"
Relative order id of this field in relation to other custom fields in the same module
Example:
3
Marks this field as required, enforced by the API and UI
Example:
true
The update key to pass back when updating this field
Example:
"2_1_8942"
Response
200
application/json
Successful Operation