updateDataItem( )


Deprecated

This method is deprecated and was replaced with update.

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

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
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?