updateDataCollection( )

Updates a data collection.

A collection ID, revision number, permissions, and at least 1 field must be provided in the collection body parameter. If a collection with that ID exists, and if its current revision number matches the one provided, it's updated. Otherwise, the request fails.

Important:

After a collection is updated, it only contains the properties included in the Update Data Collection request. If the existing collection has properties with values and those properties aren't included in the updated collection details, their values are lost.

To update only specific properties without affecting others, use Patch Data Collection.

When a collection is updated, its updatedDate changes to the current date and its revision increments by 1.

To update only properties in a collection's fields array, use Update Data Collection Field. To only add or remove plugins, use Add Data Collection Plugin or Delete Data Collection Plugin.

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 Collections
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
collectionDataCollectionRequired

Updated collection details. The existing collection is replaced with this version.

Returns
Return Type:Promise<DataCollection>
Errors

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

Did this help?