CustomFields
Update CustomField
Update an existing CustomField record.
PUT
Update CustomField
Updates an existing CustomField record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CustomField-Edit role.Enums
eCustomFieldRecordType — RecordType values
eCustomFieldRecordType — RecordType values
eFieldType — FieldType values
eFieldType — FieldType values
eCoworkerFieldPosition — CoworkerFieldPosition values
eCoworkerFieldPosition — CoworkerFieldPosition values
eFieldVisibility — Visibility values
eFieldVisibility — Visibility values
Request Body
Required Fields
ID of the location that owns this custom field. Customer fields must belong to the top-level location; other record types are available across the location network..
Required label shown for this custom field. It must be unique across the location network unless it is the linked resource/booking counterpart..
Numeric display order for this field among the location’s custom fields; lower values appear first and the server normalizes the ordering after changes..
Record type this field collects data for: Coworker, Team, FloorPlanDesk, CrmOpportunity, Visitor, Proposal, CoworkerInternal, HelpDeskMessage, HelpDeskDepartment, Product, Booking, CoworkerInvoice, Business, CoworkerContract, Tariff, Resource, FloorPlan, InventoryAsset, or Events. A Coworker field cannot later be changed to another type..
Input type and validation for captured values: Text, LongText, Boolean, Dropdown, Date, Integer, or Decimal. AvailableOptions is retained only for Dropdown..
Customer-record tab where the field is placed: General, Contact, Profile, Billing, Access, or Notes. This applies when RecordType is Coworker..
Audience and editability: Visible allows customer editing, ReadOnly shows the field without customer editing, and Internal excludes it from public-facing field lists. ReadOnly cannot be Required..
Optional Fields
Comma-separated permitted choices for a Dropdown field; submitted values must exactly match these trimmed options. The server clears this value for every other FieldType..
Whether a Dropdown field accepts more than one comma-separated choice. This setting is meaningful only when FieldType is Dropdown..
Whether a non-empty value is required when this field is submitted on its parent record. ReadOnly fields are automatically made not required..
Optional label shown for this field in customer-directory search; use it when the normal field label needs different search wording..
Whether this field is shown on a resource booking form. For Resource record types, enabling this creates or synchronizes a linked Booking custom field..
List of resources this Resource-record custom field applies to when it is shown in booking. An empty list means it applies to every resource; setting resources restricts it to those resources..
Code Examples
Response
200
Example Response
400
Example Response