Skip to main content
PUT
Update existing schema

Authorizations

x-api-key
string
header
required

API key for authentication

Path Parameters

schemaId
string
required

Schema ID

Body

application/json

Body

Request body for updating a schema

name
string

Name of the schema

Required string length: 1 - 255
entity
string | null

Entity type for the schema

Minimum string length: 1
fields
(DataField · object | ClassificationField · object)[]

Array of field definitions

Extraction field schema

Response

200

Response for schema update

error
enum<boolean>
required

Error flag (always false on success)

Available options:
false
success
boolean
required

Success flag

message
string
required

Success message

updatedSchema
object

The updated schema data (returned to avoid read-replica lag)