HomeGuidesAPI Reference
API Reference

Update workspace field

Update an existing workspace field definition by its ID.

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

The ID of the workspace field to update

Body Params

The fields to update

string
enum

Field input type

category
array of strings

Categories the field belongs to

category
Allowed:
groups
array of strings

Groups the field belongs to

groups
attributes
object

Field display attributes (name, label, placeholder, etc.)

validation
array of objects

Validation rules to apply to the field

validation
config
object

Field configuration including the Spektr data field mapping

boolean

Whether the field is locked from editing

subFields
array of objects

Sub-field definitions. The whole array is replaced when this key is present, so to add/remove/reorder a single entry you must send the full desired array (recursively).

Required when the effective type is "object" (a non-empty array); must be omitted for all other types. If type is being switched away from "object", omit subFields entirely.

subFields
Responses

401

Unauthorized — missing or invalid API key

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json