Update Custom Field
PATCH /v1/custom-fields/{field_id}
PATCH
/v1/custom-fields/{field_id}
Update mutable properties (label, options, description, etc.). If is_searchable toggles, enqueues GIN index create/drop on the default queue.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” field_id
required
Field Id
string
Request Body required
Section titled “Request Body required ” TenantFieldSchemaUpdate
Partial update for mutable TenantFieldSchema fields.
field_key and field_type are intentionally excluded — changes to either require a coordinated data migration and a version bump.
Responses
Section titled “ Responses ”Successful Response
Response[TenantFieldSchemaRead]
object
data
required
TenantFieldSchemaRead
Full representation of a TenantFieldSchema record.
object
id
required
Id
string format: uuid
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
workos_org_id
required
Workos Org Id
string
entity_type
required
Entity Type
string
field_key
required
Field Key
string
label
required
Label
string
field_type
required
FieldType
Supported custom field types. These drive both validation logic and frontend component rendering. Adding a new type here requires matching handling in validator.py.
string
options
Any of:
Array<string>
null
is_required
required
Is Required
boolean
is_searchable
required
Is Searchable
boolean
is_active
required
Is Active
boolean
sort_order
required
Sort Order
integer
version
required
Version
integer
Validation Error
HTTPValidationError
object
detail
Detail
Array<object>
ValidationErrorobject
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context