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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
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?