createDataSharingPolicy( )


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 data sharing policy for the specified collection.

You can optionally filter which items in the collection can be shared. If no filters are specified, all items in the collection are shared. You can create multiple policies for the same collection with different filters.

You can find which fields can be filtered for each collection by calling Get Data Collection. The supported filters are returned in the response under collections.fields.capabilities.queryOperators.

Important: Only collections created in the CMS or with the Data Collections API can be shared. External collections and Wix App collections can't be shared.

Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Data Collection Sharing
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsCreateDataSharingPolicyOptions
Returns
Return Type:Promise<DataSharingPolicy>
Errors
400Invalid Argument

There is 1 error with this status code.

404Not Found

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?