Skip to content
DonorIntel Knowledge Base

Reorder Custom Fields

POST
/v1/custom-fields/reorder

Bulk-update sort_order for multiple fields. Cache is invalidated for affected entity types.

Request Body required

Section titled “Request Body required ”
TenantFieldSchemaReorderRequest

Bulk reorder request — supply the new sort_order for every field in one call to avoid flickering or partial-update races in the UI.

object
items
required
Items
Array<object>
>= 1 items
TenantFieldSchemaReorderItem

A single (id → sort_order) pair used in a bulk reorder request.

object
id
required
Id
string format: uuid
sort_order
required
Sort Order
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Response Reorder Custom Fields V1 Custom Fields Reorder Post
Array<object>
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
Allowed values: text textarea number currency date boolean select multi_select url
options
Any of:
Array<string>
description
Any of:
string
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

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object