updateDataItem( )


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 an item in a collection.

This function replaces the data item's existing data with the payload provided in options.dataItem.data in the request.

To update an item, you need to specify an item ID and a collection ID. If an item is found in the specified collection with the specified ID, that item is updated. If the collection doesn't contain an item with that ID, the request fails.

When an item is updated, its data._updatedDate field is changed to the current date and time.

Note: After an item is updated, it only contains the fields included in the options.dataItem.data payload in the updateDataItem() call. If the existing item has fields with values and those fields aren't included in the updated item, their values are lost.

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 All Data Resources
Manage Data Items
Write Data Items
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

Data item ID.


optionsUpdateDataItemOptions

Options for updating an item in a collection.

Returns
Return Type:Promise<UpdateDataItemResponse>
Errors

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

Did this help?