insertDataItem( )


Developer Preview

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

Adds an item to a collection.

An item can only be inserted into an existing connection. You can create a new collection using the Data Collections API.

When an item is inserted into a collection, the item's ID is automatically assigned a random value. You can optionally provide a custom ID in dataItem.id when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.

If options.dataItem.data is empty, a new item is created with no data fields.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage All Data Resources
Manage Data Items
Write Data Items
Learn more about app permissions.
Method Declaration
Copy
function insertDataItem(
  options: InsertDataItemOptions,
): Promise<InsertDataItemResponse>;
Method Parameters
optionsInsertDataItemOptions

Options for adding an item to a collection.

Returns
Return Type:Promise<InsertDataItemResponse>
JavaScript
import { items } from "@wix/data"; async function insertDataItem(options) { const response = await items.insertDataItem(options); }
Errors

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

Did this help?