removeReference( )


Developer Preview

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

Removes a reference from the specified property.

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

Note: The removeReference() 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 from which to remove the reference.


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?