patchDataCollection( )


Developer Preview

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

Updates specified properties of a data collection.

Only updates the properties specified in the request, all other properties remain unchanged. The following properties can be updated with this method: displayName, displayField, permissions, dataPermissions. If attempting to update other, unsupported properties, this operation fails.

To update properties in a collection's fieldsarray, use Patch Data Collection Field. To add or remove plugins, use Add Data Collection Plugin or Delete Data Collection Plugin.

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

_idstringRequired

Collection ID. For example, my-first-collection. May include a namespace.

Returns
Return Type:Promise<PatchDataCollectionResponse>
Errors

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

Did this help?