connectToSharedCollection( )

Developer Preview

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

Connects the current site to a shared data collection.

When you call this method, the shared collection appears in the current site's CMS under the specified namespace. You can also access the shared collection by using the Data Items APIs.

Note: The namespace is an identifier that serves as part of the collection ID when querying collection data. Therefore, it must be unique in a site.

Method Declaration
Copy
Method Parameters
namespacestringRequired

Namespace to connect collection with on the target site. Must be unique in the site.

optionsConnectToSharedCollectionOptions
Returns
Return Type:Promise<ConnectToSharedCollectionResponse>
Errors
403Permission Denied

There is 1 error with this status code.

404Not Found

There is 1 error with this status code.

409Already Exists

There are 3 errors with this status code.

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

Did this help?