---
title: "Create entry"
description: "Creates a draft entry in a product."
---

> 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.

# Create entry

Needs the entry:write scope.

Rich text (preview) is HTML in a closed format: p, h1 to h3, br, strong, em, u, s, sup, sub, code, a (href), span (style color, background-color), text-align on p and h1 to h3, ul, ol, li (data-checked), table rows and cells, pre with code, blockquote, hr, details with summary, figure with figcaption, and <block type="…" props="{…}" /> for images, videos, audio, slideshows, formulas, diagrams and other blocks, their props as getBodySchema lists them; anything else is refused with its path and reason. E.g. <h2>Intro</h2><p>Read <strong>this</strong> first.</p> Set text\_format to "markdown" to write Markdown instead.

## Call

- Tool: `create_entry`
- Scope: `entry:write`
- Writes, adding without changing what is there.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `store` | `string` | No | The store to act on. |
| `text_format` | `"html" or "markdown"` | No | The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way. |
| `full` | `true` | No | Answers the texts, attachments and file lists the short answer leaves out. |
| `product` | `object` | Yes |  |
| `slug` | `string` | No | Made from the title when absent: its words, numbered past a twin under the product and the product's own routes, which a given one may not name either. |
| `title` | `string` | Yes |  |
| `subtitle` | `string or null` | No |  |
| `section` | `string or null` | No |  |
| `author` | `object or null` | No | Who signs it; null leaves it unsigned. A new entry is signed by the member writing it, or by the store with no member behind the call. |
| `tags` | `array of string` | No | Labels the product's entries are listed by, in this order, none twice ignoring case: visible, well-formed text with no comma, its words parted by single plain spaces. |
| `unlisted` | `boolean` | No | Reachable by id or slug but out of the product's lists, the sitemap and notifications, and served noindex; the first unlist's stamp is kept. |
| `preview` | `string or null` | No | The teaser, a rich text with the blocks a lesson takes, stored in its canonical form in 16 KiB of UTF-8, an image it starts showing at most 15 MB; empty clears it. |
| `release` | `object or null` | No | An event entry's release relative to one of its sessions, its content locked to everyone until then; null opens it as published. |
| `settings` | `object` | No |  |
| `metadata` | `object` | No |  |
| `place` | `"chapter"` | No | After the last entry of its chapter, or past the product's last when the chapter has none; an update moves it only when its section changes. |
| `new_section` | `true` | No | Refuse a section another chapter holds, so a new chapter never joins one by accident. |
| `held_section` | `true` | No | Refuse a section no chapter holds as `not_found`, so a chapter renamed or removed meanwhile never comes back; no chapter always passes; not with `new_section`. |

```json
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "text_format": {
      "type": "string",
      "enum": [
        "html",
        "markdown"
      ],
      "default": "html",
      "description": "The format the rich text fields are written in: the rich text format’s HTML, or Markdown converted into it before it is validated. A text already stored in the format (starting with `<rich-text`) is kept as it is either way."
    },
    "full": {
      "description": "Answers the texts, attachments and file lists the short answer leaves out.",
      "type": "boolean",
      "const": true
    },
    "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": {
      "description": "Made from the title when absent: its words, numbered past a twin under the product and the product's own routes, which a given one may not name either.",
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "pattern": "^[a-z0-9]+(?:-[a-z0-9]+)*$"
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "subtitle": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ]
    },
    "section": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ]
    },
    "author": {
      "description": "Who signs it; null leaves it unsigned. A new entry is signed by the member writing it, or by the store with no member behind the call.",
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "member"
            },
            "user": {
              "description": "A user holding a seat on the store's business now.",
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 512
                }
              },
              "required": [
                "id"
              ],
              "additionalProperties": false
            }
          },
          "required": [
            "kind",
            "user"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "business"
            }
          },
          "required": [
            "kind"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "const": "store"
            }
          },
          "required": [
            "kind"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "tags": {
      "description": "Labels the product's entries are listed by, in this order, none twice ignoring case: visible, well-formed text with no comma, its words parted by single plain spaces.",
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 60,
        "pattern": "^[^\\s,\\u0000-\\u001f\\u007f-\\u009f]( ?[^\\s,\\u0000-\\u001f\\u007f-\\u009f])*$"
      },
      "maxItems": 20
    },
    "unlisted": {
      "description": "Reachable by id or slug but out of the product's lists, the sitemap and notifications, and served noindex; the first unlist's stamp is kept.",
      "type": "boolean"
    },
    "preview": {
      "description": "The teaser, a rich text with the blocks a lesson takes, stored in its canonical form in 16 KiB of UTF-8, an image it starts showing at most 15 MB; empty clears it.",
      "anyOf": [
        {
          "type": "string",
          "maxLength": 4096
        },
        {
          "type": "null"
        }
      ],
      "x-rich-text": "text"
    },
    "release": {
      "description": "An event entry's release relative to one of its sessions, its content locked to everyone until then; null opens it as published.",
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "session": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 512
                }
              },
              "required": [
                "id"
              ],
              "additionalProperties": false
            },
            "anchor": {
              "description": "Which end of the session the offset counts from.",
              "type": "string",
              "enum": [
                "start",
                "end"
              ]
            },
            "offset_minutes": {
              "description": "Minutes from the anchor, negative before it, within 30 days.",
              "type": "integer",
              "minimum": -43200,
              "maximum": 43200
            }
          },
          "required": [
            "session",
            "anchor",
            "offset_minutes"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "settings": {
      "type": "object",
      "properties": {
        "ai_generated": {
          "description": "The description was machine-written, which readers are told.",
          "type": "boolean"
        }
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "boolean"
          },
          {
            "type": "string"
          },
          {
            "type": "number"
          },
          {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "object",
            "properties": {},
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "boolean"
                  },
                  {
                    "type": "string"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "array",
                    "items": {
                      "anyOf": [
                        {
                          "type": "boolean"
                        },
                        {
                          "type": "string"
                        },
                        {
                          "type": "number"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            }
          },
          {
            "type": "object",
            "properties": {},
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "array",
                        "items": {
                          "anyOf": [
                            {
                              "type": "boolean"
                            },
                            {
                              "type": "string"
                            },
                            {
                              "type": "number"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": {
                      "anyOf": [
                        {
                          "type": "boolean"
                        },
                        {
                          "type": "string"
                        },
                        {
                          "type": "number"
                        },
                        {
                          "type": "array",
                          "items": {
                            "anyOf": [
                              {
                                "type": "boolean"
                              },
                              {
                                "type": "string"
                              },
                              {
                                "type": "number"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  }
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "metadata": {
      "type": "object",
      "properties": {},
      "additionalProperties": {
        "anyOf": [
          {
            "type": "boolean"
          },
          {
            "type": "string"
          },
          {
            "type": "number"
          },
          {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "object",
            "properties": {},
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "boolean"
                  },
                  {
                    "type": "string"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "array",
                    "items": {
                      "anyOf": [
                        {
                          "type": "boolean"
                        },
                        {
                          "type": "string"
                        },
                        {
                          "type": "number"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            }
          },
          {
            "type": "object",
            "properties": {},
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "array",
                        "items": {
                          "anyOf": [
                            {
                              "type": "boolean"
                            },
                            {
                              "type": "string"
                            },
                            {
                              "type": "number"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": {
                      "anyOf": [
                        {
                          "type": "boolean"
                        },
                        {
                          "type": "string"
                        },
                        {
                          "type": "number"
                        },
                        {
                          "type": "array",
                          "items": {
                            "anyOf": [
                              {
                                "type": "boolean"
                              },
                              {
                                "type": "string"
                              },
                              {
                                "type": "number"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  }
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "place": {
      "description": "After the last entry of its chapter, or past the product's last when the chapter has none; an update moves it only when its section changes.",
      "type": "string",
      "const": "chapter"
    },
    "new_section": {
      "description": "Refuse a section another chapter holds, so a new chapter never joins one by accident.",
      "type": "boolean",
      "const": true
    },
    "held_section": {
      "description": "Refuse a section no chapter holds as `not_found`, so a chapter renamed or removed meanwhile never comes back; no chapter always passes; not with `new_section`.",
      "type": "boolean",
      "const": true
    }
  },
  "required": [
    "product",
    "title"
  ],
  "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/create-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/create_entry/index.mdx
