Update Database Schema Draft

Saves the working-copy draft of a database schema.

A schema defines a collection's fields, types, and validation. Schemas support drafts, versions, and publishing.

This endpoint updates the database schema draft — only the fields you send are changed.

Saves the working-copy draft of a database schema

put

Authorizations

Bearer

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

IdstringRequired

Schema id whose draft to replace, from get_database_schemas.

Body

multipart/form-dataapplication/json

Saves the working-copy draft of a database schema

correlationIdstring · nullableOptional

CorrelationId for each request

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

dataSchemastring · nullableOptional

Raw JSON string matching the Norbix data meta-schema (https://norbix.ai/schemas/meta/v1.json) for the draft's data schema.

visualSchemastring · nullableOptional

Raw JSON string matching the Norbix UI/visual meta-schema (https://norbix.ai/schemas/ui/v1.json) for the draft's record form.

Responses

200

OK

application/json

put/{version}/database/schemas/{Id}/draft

HTTPcURLJavaScriptPython

PUT /{version}/database/schemas/{Id}/draft HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 139

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "dataSchema": "text",
  "visualSchema": "text"
}

multipart/form-dataapplication/json

200

OK

{
  "responseStatus": {
    "isSuccess": true
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Database.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Update Database Schema Draft in the SDK reference, with examples in every language.