updateDataCollection( )

Updates a data collection.

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

When a collection is updated, its _updatedDate property is changed to the current date and its revision property is incremented.

Note: After a collection is updated, it only contains the properties included in the updateDataCollection() call. If the existing collection has properties with values and those properties aren't included in the updated collection details, their values are lost.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Data Collections
Learn more about permission scopes.
Method Declaration
Method Parameters

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

Return Type:Promise<DataCollection>
Was this helpful?