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