PATCH

Update Schema


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a translation schema.

To remove a field, pass the field key with an empty object as the value. For example:

Copy
Caution:

Removing a schema field makes the corresponding content field unavailable.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Wix Multilingual - Translation Schema Write
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/translation-schema/v1/schemas/{schema.id}

Path Params
schema.idstringRequired

Translation schema ID.

Body Params
schemaSchemaRequired

Translation schema to update.

Response Object
schemaSchema

Updated Schema.

Update Schema
Request
cURL
curl -X PATCH \ 'https://www.wixapis.com/translation-schema/v1/schemas/8046df3c-7575-4098-a5ab-c91ad8f33c47' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ --data-binary '{ "schema": { "displayName": "A New Display Name", "revision": 1, }, }'
Response
JSON
{ "schema": { "id": "8046df3c-7575-4098-a5ab-c91ad8f33c47", "revision": 1, "createdDate": "2019-10-30T17:22:10.299Z", "updatedDate": "2019-10-30T17:22:10.299Z", "key": { "appId": "4ad2dfe1-a943-45a8-94ac-f1dd8b78821b", "entityType": "Product", "scope": "GLOBAL" }, "display_name": "A new Display Name", "fields": { "title": { "id": "title", "type": "SHORT_TEXT", "displayName": "Title", "minLength": 1, "maxLength": 54, "hidden": false, "displayOnly": false }, "description": { "id": "description", "type": "RICH_CONTENT", "displayName": "Description", "minLength": 1, "maxLength": 256, "hidden": false, "displayOnly": false }, "image()": { "id": "image()", "type": "IMAGE", "displayName": "Product's Image", "minLength": null, "maxLength": null, "hidden": false, "displayOnly": false } } } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Did this help?