---
title: "Unpublish entry"
description: "Takes an entry back to draft."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Unpublish entry

Needs the entry:write scope.

## Call

- Tool: `unpublish_entry`
- Scope: `entry:write`
- Writes, and may change or remove what is there.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `store` | `string` | No | The store to act on. |
| `product` | `object` | Yes |  |
| `entry` | `object` | Yes |  |
| `full` | `true` | No | Answers the texts, attachments and file lists the short answer leaves out. |

```json
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "entry": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "product": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 512
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "slug": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 512
                    }
                  },
                  "required": [
                    "slug"
                  ],
                  "additionalProperties": false
                }
              ]
            },
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "product",
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "full": {
      "description": "Answers the texts, attachments and file lists the short answer leaves out.",
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "product",
    "entry"
  ],
  "additionalProperties": false
}
```

## Answer

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `search` | `string or null` | Yes |  |
| `status` | `string` | Yes |  |
| `id` | `string` | Yes |  |
| `slug` | `string` | Yes |  |
| `title` | `string` | Yes |  |
| `subtitle` | `string or null` | Yes |  |
| `published_at` | `string or null` | Yes |  |
| `unlisted_at` | `string or null` | Yes |  |
| `created_at` | `string or null` | Yes |  |
| `updated_at` | `string or null` | Yes |  |
| `settings` | `object` | Yes |  |
| `metadata` | `object` | Yes |  |
| `unlisted` | `boolean` | Yes |  |
| `section` | `string or null` | Yes |  |
| `position` | `number` | Yes |  |
| `in_use` | `array of object` | Yes |  |
| `product_id` | `string` | Yes |  |
| `tags` | `array of string` | Yes |  |
| `released_at` | `string or null` | Yes | Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release. |
| `path` | `string` | Yes | The storefront path. |
| `url` | `string or null` | Yes | The absolute URL on the store's verified hostname, or null before it has one. |
| `release` | `object or null` | Yes | When its content opens relative to one of its event's sessions, or null when it opens as published. |
| `access` | `array of object` | Yes |  |
| `author` | `object or null` | Yes | Who signs it, or null when unsigned. |
| `preview` | `string or null` | No | The teaser, in the rich text format as stored; answered only with `full`. |
| `attachments` | `array of object` | No | Every attachment on the entry with its asset whole; answered only with `full`. |
| `files` | `object` | No | The files its teaser names, and every other file it binds; answered only with `full`. |
| `quizzes` | `object` | No | Its quiz versions, the current one first; answered only with `full`. |
| `created` | `array of object` | Yes | The attachments the write bound: the files a new teaser names. |

The answer's full shape is on [its API reference page](/merchant-api/reference/unpublish-entry).

## Errors

A refused call is a tool error. Its `structuredContent` holds a `code` and its `context`, except for `client-fault`. This tool may answer:

- `invalid`: an argument is malformed; `context.path` names it.
- `invalid` at `["store"]`: `store` is missing while the connection reaches more than one store, or names a store it doesn't reach.
- `not_found`: nothing matches a reference given.
- `conflict`: the call clashes with the current state; `context` names the field and, where it helps, its current value, and for a `from`, `live`, `expect` or version that no longer matches, the argument (`path`) and what it takes (`reason`).
- `not_permitted`: this connection may not make this call. When `context.reason` is `limit`, too many calls: `retry_after` says when to try again.
- `internal` or `unavailable`: the call failed inside Sherpo, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.
- `client-fault`: the server failed around the call. `core_answer` `ok` means the write landed, so don't send it again. When `reached_core` is false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying again.
- HTTP 403 with `insufficient_scope`: the connection lacks the scope this tool needs.
- HTTP 401 with `invalid_token`: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a `conflict` when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See [Errors](/merchant-mcp/errors) for every code and its context.

Source: https://docs.sherpo.io/merchant-mcp/tools/unpublish_entry/index.mdx
