> 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

# UnpublishDataItem

# Package: cms

# Namespace: DataItemService

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

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

## Introduction

Retracts a published data item back to draft state.


By default, this method removes the published copy of the item and creates a draft seeded with the previously-published data. Set `copyToDraft` to `false` to remove the published item without creating a draft.

Pass the **published** collection ID as `dataCollectionId` (for example, `articles`).

After unpublishing, edit the resulting draft via [Update Data Item](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/update-data-item.md) or [Patch Data Item](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/patch-data-item.md) with `dataCollectionId` set to your collection's drafts shadow (for example, `articles__drafts`). To put the item back live, call [Publish Data Item Draft](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/publish-data-item-draft.md).

> **Notes:**
> - If a pending draft already exists for the supplied `dataItemId`, it is silently overwritten with the previously-published data.
> - The response carries the newly-created (or overwritten) draft, not the previously-published item. When `copyToDraft` is `false`, `dataItem` is not returned.
> - Returns `NOT_FOUND` if no published item exists with the supplied `dataItemId`.
> - Calling this method always triggers a [Data Item Deleted](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-item-deleted.md) event on the published collection. When `copyToDraft` is `true` (the default), it also triggers a [Data Item Created](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-item-created.md) or [Data Item Updated](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-item-updated.md) event on the drafts shadow collection. When `copyToDraft` is `false`, no draft is created and no events fire on the drafts shadow collection.

---

## REST API

### Schema

```
 Method: unpublishDataItem
 Description: Retracts a published data item back to draft state.   By default, this method removes the published copy of the item and creates a draft seeded with the previously-published data. Set `copyToDraft` to `false` to remove the published item without creating a draft.  Pass the **published** collection GUID as `dataCollectionId` (for example, `articles`).  After unpublishing, edit the resulting draft via [Update Data Item](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/update-data-item.md) or [Patch Data Item](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/patch-data-item.md) with `dataCollectionId` set to your collection's drafts shadow (for example, `articles__drafts`). To put the item back live, call [Publish Data Item Draft](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/publish-data-item-draft.md).  > **Notes:** > - If a pending draft already exists for the supplied `dataItemId`, it is silently overwritten with the previously-published data. > - The response carries the newly-created (or overwritten) draft, not the previously-published item. When `copyToDraft` is `false`, `dataItem` is not returned. > - Returns `NOT_FOUND` if no published item exists with the supplied `dataItemId`. > - Calling this method always triggers a [Data Item Deleted](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-item-deleted.md) event on the published collection. When `copyToDraft` is `true` (the default), it also triggers a [Data Item Created](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-item-created.md) or [Data Item Updated](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-item-updated.md) event on the drafts shadow collection. When `copyToDraft` is `false`, no draft is created and no events fire on the drafts shadow collection.
 URL: https://www.wixapis.com/wix-data/v2/items/unpublish
 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, dataItemId
 Method parameters: 
   param name: copyToDraft | type: copyToDraft | description: Whether to create a draft copy of the published item. If `true`, any existing draft will be overwritten. If `false`, the published item is simply removed without creating a draft. The response `dataItem` is not returned. Defaults to `true`.  
   param name: dataCollectionId | type: dataCollectionId | description: GUID of the published data collection. | required: true | validation: maxLength 256
   param name: dataItemId | type: dataItemId | description: GUID of the published data item to retract. Returns `NOT_FOUND` if no published item exists with this GUID. | required: true | validation: maxLength 128
 Return type: UnpublishDataItemResponse
  - name: dataItem | type: DataItem | description: The resulting draft data item, seeded with the previously-published data. Empty when `copyToDraft` is `false`.  
     - name: id | type: string | description: Data item GUID.  When an item is inserted into a collection, the item's GUID is automatically assigned a random value. You can optionally provide a custom GUID in `dataItem.id` when inserting the item. If you specify an GUID that already exists in the collection, the insertion will fail.  | validation: maxLength 128, immutable
     - name: dataCollectionId | type: string | description: GUID of the collection this item belongs to.  This is the user-defined collection identifier set when the collection is created (for example, `EvalCustomers`), not a GUID.  | read-only: true | validation: maxLength 256
     - name: data | type: object | description: Data item contents.  Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:  + `_id`: Item GUID. + `_createdDate`: Date and time the item was added to the collection. + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value. + `_ownerId`: GUID of the user who created the item. Can be modified with site owner permissions.  


```

### Examples

### Unpublish a live item back to draft
```curl
curl -X POST \
'https://www.wixapis.com/wix-data/v2/items/unpublish' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
    "dataCollectionId": "tutorials",
    "dataItemId": "5331fc15-9441-4fd4-bc7b-7f6870c69228"
}'
```

---