Skip to content

Validate Custom Field Values

POST
/v1/custom-fields/validate

Validate a map of field_key → value against the registered schemas for an entity type. Uses cache when available. Returns errors without raising so callers can decide how to handle.

CustomFieldValueValidationRequest

Request body to validate a map of field_key → value against the registered TenantFieldSchema definitions for a given entity type.

Used by the validator.py module and can also be called directly via a /validate endpoint during form submission.

object
entity_type
required
Entity Type
string
>= 1 characters <= 100 characters
values
required
Values

Map of field_key to the submitted value, matching entity metadata shape.

object
key
additional properties
any

Successful Response

CustomFieldValueValidationResponse

Result of a metadata validation pass.

object
is_valid
required
Is Valid
boolean
errors
Errors
Array<object>
CustomFieldValueValidationError

A single field-level validation failure.

object
field_key
required
Field Key
string
label
required
Label
string
message
required
Message
string

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