Skip to main content
PUT
/
v4
/
schemas
/
{schemaId}
Update existing schema
curl --request PUT \
  --url https://api.kadoa.com/v4/schemas/{schemaId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "entity": "<string>",
  "fields": [
    {
      "name": "<string>",
      "description": "<string>",
      "dataType": "STRING",
      "fieldType": "SCHEMA",
      "example": "<string>",
      "isKey": true
    }
  ]
}
'
{
  "error": false,
  "success": true,
  "message": "<string>",
  "updatedSchema": {
    "id": "<string>",
    "name": "<string>",
    "isPublic": true,
    "schema": [
      {
        "name": "<string>",
        "description": "<string>",
        "dataType": "STRING",
        "fieldType": "SCHEMA",
        "example": "<string>",
        "isKey": true
      }
    ],
    "entity": "<string>",
    "description": {
      "hintText": "<string>"
    }
  }
}

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 | RawContentField · 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:
true,
false
​
success
boolean
required

Success flag

​
message
string
required

Success message

​
updatedSchema
object

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