insertReference( )


Developer Preview

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

Inserts a reference in the specified property.

The insertReference() method 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.

Notes:

  • The insertReference() method only applies to multi-reference fields.
  • The insertReference() method is not supported for Single Item Collections.
Permissions
Write Data Items
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
dataCollectionIdstringRequired

ID of the collection that contains the referring item.


fieldstringRequired

Field to insert the reference into.


referringItemunionRequired

Referring item or referring item's ID.


referencedItemunionRequired

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


optionsWixDataOptions

Options to use when processing this operation.

Did this help?