Skip to content
DonorIntel Knowledge Base

Restore Custom Field

POST
/v1/custom-fields/{field_id}/restore

Restore a previously archived field. If the field is searchable, enqueues CREATE INDEX CONCURRENTLY.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
field_id
required
Field Id
string

Request Body required

Section titled “Request Body required ”
TenantFieldSchemaRestore

Request body to restore a previously archived custom field (sets is_active=True).

object
confirm
required
Confirm

Must be True to restore the archived field.

boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

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
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
meta
ResponseMeta

Metadata included in every response envelope.

object
request_id
Any of:
string
organization_id
Any of:
string

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