replaceDataItemReferences( )

Developer Preview

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

Replaces references in a specified field of a specified data item.

This function replaces the existing reference or references contained in the field specified in options.referringItemFieldName within the data item specified in options.referringItemId. The function removes existing references and in their place it adds references to the items specified in options.newReferencedItemIds.

Note: If you pass an empty array in options.newReferencedItemIds, all existing references are removed.

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
Method Parameters
optionsReplaceDataItemReferencesOptions

Options for replacing references.

Returns
Return Type:Promise<ReplaceDataItemReferencesResponse>
Errors

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

Did this help?