insertReference( )

Inserts a reference in the specified property.

The insertReference() function returns a Promise that resolves when a reference to the referenced item(s) is added to the referring item in the specified property. The Promise is rejected if the current user does not have update permissions for the collection.

Calling the insertReference() function does not trigger any hooks.

Notes:

  • The insertReference() function only applies to multi-reference fields.
  • The insertReference() function is not supported for Single Item Collections.
Method Declaration
Copy
Method Parameters
collectionIdstringRequired

The ID of the collection that contains the referring item.

To find your collectionId, select the Databases tab in the Velo Sidebar. Hover over your collection, click the three dots, and select Edit Settings.

propertyNamestringRequired

The property to insert the reference into.

referringItemunionRequired

The referring item or referring item's ID.

referencedItemunionRequired

The referenced item, referenced item's ID, an array of referenced items, or an array of referenced item IDs.

optionsWixDataOptions

An object containing options to use when processing this operation.

Was this helpful?
Yes
No