POST

Create Data Extension 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.

Creates a user-defined data extension schema.

Authentication

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

Permissions
Manage Data Extensions Schemas
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/schema-service/v1/schemas

Body Params
dataExtensionSchemaDataExtensionSchemaRequired

Schema to create.

Response Object
dataExtensionSchemaDataExtensionSchema

Created schema.

Create Data Extension Schema Example 1
Request
cURL
curl -X POST \ 'https://www.wixapis.com/schema-service/v1/schemas' \ -H 'Content-type: application/json' \ -H 'Authorization: <AUTH>' \ -d '{ "dataExtensionSchema": { "fqdn": "wix.ecom.*.order", "namespace": "_user_fields", "jsonSchema": { "properties": { "myCustomField1": { "type": "string", "maxLength": 50, "x-wix-permissions": { "read": [ "users-of-users", "users", "apps" ], "write": [ "users" ] } } } } } }'
Response
JSON
{ "dataExtensionSchema": { "id": "01ea0c8d-80b8-46e3-bfda-611b3678545b", "fqdn": "wix.ecom.*.order", "namespace": "_user_fields", "jsonSchema": { "additionalProperties": false, "properties": { "myCustomField1": { "maxLength": 50, "type": "string", "x-wix-created-date": "2024-10-08T12:13:38.592731806Z", "x-wix-permissions": { "read": ["users-of-users", "users", "apps"], "write": ["users"] } } } }, "updatedDate": "2024-10-08T12:13:38.639Z", "createdDate": "2024-10-08T12:13:38.639Z", "revision": "1", "maxLimitBytes": 10000, "currentSizeBytes": 50, "extensionPoint": "ROOT" } }
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?