Sign in

v1

latestOpenAPI 3.0.02026-08-06194226589.8 KB
Schemas

Update a schema.

put/api/apps/{app}/schemas/{schema}

Path parameters

appstring required

The name of the app.

schemastring required

The name of the schema.

Request body

labelstring nullable

Optional label for the editor.

hintsstring nullable

Hints to describe the schema.

contentsSidebarUrlstring nullable

The url to a the sidebar plugin for content lists.

contentSidebarUrlstring nullable

The url to a the sidebar plugin for content items.

contentsListUrlstring nullable

The url to the content list plugin.

validateOnPublishboolean

True to validate the content items on publish.

tagsstring[] nullable

Tags for automation processes.

Response

Schema updated.

_linksobject required

The links.

idstring required

The ID of the schema.

createdBystring required

The user that has created the schema.

lastModifiedBystring required

The user that has updated the schema.

namestring required

The name of the schema. Unique within the app.

type'Default' | 'Singleton' | 'Component' required
categorystring nullable

The name of the category.

isSingletonboolean required

Indicates if the schema is a singleton.

isPublishedboolean required

Indicates if the schema is published.

createdstring date-time required

The date and time when the schema has been created.

lastModifiedstring date-time required

The date and time when the schema has been modified last.

versioninteger required

The version of the schema.

previewUrlsobject required

The preview Urls.

fieldsInListsstring[] required

The name of fields that are used in content lists.

fieldsInReferencesstring[] required

The name of fields that are used in content references.