This endpoint is used to patch a schema.
The schemaId field is used to specify the schema that should be patched. The fields field is used to specify the fields that should be updated.
The fields field is an array of fields. Each field contains the following fields:
- title: The title of the field. This is the human-readable name of the field.
- description: The description of the field. This is a human-readable description of the field.
- type: The type of the field. This can be either STRING, NUMBER, BOOLEAN, DATE, or OBJECT.
- format: The format of the field. This is a string that indicates the format of the field.
- hidden: Whether the field is hidden or not. This is a boolean value that indicates whether the field is hidden or not.
- internet_context: Whether the field is internet context or not. This is a boolean value that indicates whether the field is internet context or not.
- fieldSuggestion: The field suggestion of the field. This is an object that contains the following fields:
- id: The ID of the field suggestion. This is the unique identifier for the field suggestion.
- name: The name of the field suggestion. This is the human-readable name of the field suggestion.
- items: The items of the field. This is an array of fields that are the items of the field.
- value: The value of the field. This is the value of the field.
- enumValues: The enum values of the field. This is an array of strings that are the enum values of the field.
- inlineListType: The inline list type of the field. This is a string that indicates the inline list type of the field.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
schemaId | string | Yes | Unique identifier of the schema to update |
fields | array | Yes | Array of field objects to update or add |
Field Object Structure
Each field in the fields array can contain the following properties:
| Property | Type | Required | Description |
|---|---|---|---|
title | string | No | Human-readable name of the field |
description | string | No | Detailed description of the field's purpose |
type | string | No | Data type: STRING, NUMBER, BOOLEAN, DATE, or OBJECT |
format | string | No | Specific format specification for the field |
hidden | boolean | No | Whether the field should be hidden from display |
internet_context | boolean | No | Whether the field relates to internet/web context |
fieldSuggestion | object | No | Suggested values configuration |
items | array | No | For array/list fields, defines the structure of list items |
value | any | No | Default or current value of the field |
enumValues | array | No | Array of allowed string values for enum fields |
inlineListType | string | No | Type specification for inline list formatting |
Field Suggestion Object
When using fieldSuggestion, the object structure is:
| Property | Type | Description |
|---|---|---|
id | string | Unique identifier for the suggestion |
name | string | Display name for the suggestion |
Example Request
{
"schemaId": "user-profile-schema-123",
"fields": [
{
"title": "Full Name",
"description": "User's complete name including first and last name",
"type": "STRING",
"hidden": false,
"value": ""
},
{
"title": "Age",
"description": "User's age in years",
"type": "NUMBER",
"format": "integer",
"hidden": false
},
{
"title": "Account Status",
"description": "Current status of the user account",
"type": "STRING",
"enumValues": ["active", "inactive", "suspended", "pending"],
"fieldSuggestion": {
"id": "status-suggestion-1",
"name": "Account Status Options"
}
},
{
"title": "Preferences",
"description": "User preference settings",
"type": "OBJECT",
"hidden": false,
"items": [
{
"title": "Email Notifications",
"type": "BOOLEAN",
"value": true
}
]
}
]
}