> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# ReplaceDataItemReferences

# Package: cms

# Namespace: DataItemService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/cms/data-items/replace-data-item-references.md

## Permission Scopes:
Write Data Items: SCOPE.DC-DATA.WRITE

## Introduction

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


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

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

---

## REST API

### Schema

```
 Method: replaceDataItemReferences
 Description: Replaces references in a specified field of a specified data item.   This method replaces the existing reference or references contained in the field specified in `referringItemFieldName` within the data item specified in `referringItemId`. The method removes existing references and in their place it adds references to the items specified in `newReferencedItemIds`.  > **Note:** If you pass an empty array in `newReferencedItemIds`, all existing references are removed.
 URL: https://www.wixapis.com/wix-data/v2/items/replace-references
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  dataCollectionId, referringItemFieldName, referringItemId
 Method parameters: 
   param name: dataCollectionId | type: dataCollectionId | description: GUID of the collection containing the referring item. | required: true
   param name: newReferencedItemIds | type: array<newReferencedItemIds> | description: List of new referenced item GUIDs to replace the existing ones. 
   param name: referringItemFieldName | type: referringItemFieldName | description: Field containing references in the referring item. | required: true
   param name: referringItemId | type: referringItemId | description: GUID of the referring item. | required: true
 Return type: ReplaceDataItemReferencesResponse
  - name: dataItemReferences | type: array<DataItemReference> | description: Updated references. 
     - name: referringItemFieldName | type: string | description: Referring item field containing the references to the referenced items. 
     - name: referringItemId | type: string | description: GUID of the referring item. 
     - name: referencedItemId | type: string | description: GUID of the referenced item. 


```

### Examples

### Replace existing references with new references
```curl
curl -X POST \
'https://www.wixapis.com/wix-data/v2/items/replace-references' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
    "dataCollectionId": "albums",
    "referringItemFieldName": "songs",
    "referringItemId": "37de298e-026d-4b2e-b87f-fbec11d53105",
    "newReferencedItemIds": ["aafeaaf4-6192-4cc2-a79b-97ce0f1b3646"]
}'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.cms.DataItemService.replaceDataItemReferences(dataCollectionId, field, referringItem, referencedItem, options)
 Description: Replaces references in a specified field of a specified data item.   This method replaces the existing reference or references contained in the field specified in `referringItemFieldName` within the data item specified in `referringItemId`. The method removes existing references and in their place it adds references to the items specified in `newReferencedItemIds`.  > **Note:** If you pass an empty array in `newReferencedItemIds`, all existing references are removed.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  dataCollectionId, field, referringItem, referencedItem
 Method parameters: 
   param name: dataCollectionId | type: string | description: GUID of the collection containing the referring item. | required: true
   param name: field | type: string | description: Field containing references in the referring item. | required: true
   param name: options | type: WixDataOptions  none 
        - name: suppressHooks | type: boolean | description: Prevents hooks from running for the operation. Can only be used in the [backend code of a Wix site](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend.md). 
        - name: showDrafts | type: boolean | description: When `true`, operations include draft items. Read operations include draft items in their response, and write operations modify draft items. Default: `false`. 
        - name: appOptions | type: object | description: Options for [querying Wix app collections](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections.md). 
   param name: referencedItem | type: array<array> | description: List of new referenced item GUIDs to replace the existing ones. | required: true
   param name: referringItem | type: string | description: GUID of the referring item. | required: true
 Return type: PROMISE<VoidResponse>
  EMPTY-OBJECT {}


```

### Examples

### replaceReferences
```javascript
import { items } from '@wix/data';

async function replaceReferences(dataCollectionId,field,referringItem,referencedItem,options) {
  const response = await items.replaceReferences(dataCollectionId,field,referringItem,referencedItem,options);
};
```

### replaceReferences (with elevated permissions)
```javascript
import { items } from '@wix/data';
import { auth } from '@wix/essentials';

async function myReplaceReferencesMethod(dataCollectionId,field,referringItem,referencedItem,options) {
  const elevatedReplaceReferences = auth.elevate(items.replaceReferences);
  const response = await elevatedReplaceReferences(dataCollectionId,field,referringItem,referencedItem,options);
}
```

### replaceReferences (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { items } from '@wix/data';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { items },
  // Include the auth strategy and host as relevant
});


async function replaceReferences(dataCollectionId,field,referringItem,referencedItem,options) {
  const response = await myWixClient.items.replaceReferences(dataCollectionId,field,referringItem,referencedItem,options);
};
```

---