Skip to content
Navigation

Updates an entry's fields.

PATCH
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/entries/{entry}

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • entry
    string
    required
    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON optional

  • text_format
    optional
    html
    or
    markdown

    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.

    default: "html"
  • title
    optional
    string
    maxLength: 200 · minLength: 1
  • subtitle
    optional

    One of the following:

    • string
    • null
  • metadata
    optional
    map of
    any of
  • unlisted
    optional
    boolean

    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.

  • section
    optional

    One of the following:

    • string
    • null
  • preview
    optional

    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.

    One of the following:

    • string
    • null
  • tags
    optional
    array of
    string

    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.

    maxLength: 60 · minLength: 1 · pattern: ^[^\s,\u0000-\u001f\u007f-\u009f]( ?[^\s,\u0000-\u001f\u007f-\u009f])*$
  • release
    optional

    An event entry's release relative to one of its sessions, its content locked to everyone until then; null opens it as published.

    One of the following:

    • object
    • null
  • full
    optional
    boolean

    Answers the texts, attachments and file lists the short answer leaves out.

  • author
    optional

    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.

    One of the following:

    • object
    • object
    • object
    • null
  • place
    optional
    string

    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
    optional
    boolean

    Refuse a section another chapter holds, so a new chapter never joins one by accident.

  • held_section
    optional
    boolean

    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.

  • settings
    optional
    object

    Merged onto the stored settings; null deletes a key.

    • ai_generated
      optional

      The description was machine-written, which readers are told.

      One of the following:

      • boolean
      • null
  • from
    optional
    object

    The fields the caller read; one holding another value now refuses.

    • title
      optional
      string
    • subtitle
      optional

      One of the following:

      • string
      • null
    • section
      optional

      One of the following:

      • string
      • null
    • author
      optional

      One of the following:

      • object
      • object
      • object
      • null
    • tags
      optional
      array of
      string
    • unlisted
      optional
      boolean
    • preview
      optional

      One of the following:

      • string
      • null
    • settings
      optional
      object

      An entry without ai_generated holds false.

      • ai_generated
        optional
        boolean

Returns

200

Updates an entry's fields.

JSON
  • search
    required

    One of the following:

    • string
    • null
  • status
    string
    required
  • id
    string
    required
  • slug
    string
    required
  • title
    string
    required
  • subtitle
    required

    One of the following:

    • string
    • null
  • published_at
    required

    One of the following:

    • string
    • null
  • unlisted_at
    required

    One of the following:

    • string
    • null
  • created_at
    required

    One of the following:

    • string
    • null
  • updated_at
    required

    One of the following:

    • string
    • null
  • settings
    object
    required
    • ai_generated
      optional
      boolean

      The description was machine-written, which readers are told.

  • metadata
    map of
    any of
    required
  • unlisted
    boolean
    required
  • section
    required

    One of the following:

    • string
    • null
  • position
    number
    required
  • in_use
    array of
    object
    required
    • kind
      string
      required
    • count
      number
      required
  • product_id
    string
    required
  • tags
    array of
    string
    required
  • released_at
    required

    Since when a write keeps its passed release open, so a later release no longer locks it; cleared with the release.

    One of the following:

    • string
    • null
  • path
    string
    required

    The storefront path.

  • url
    required

    The absolute URL on the store's verified hostname, or null before it has one.

    One of the following:

    • string
    • null
  • release
    required

    When its content opens relative to one of its event's sessions, or null when it opens as published.

    One of the following:

    • object
    • null
  • access
    array of
    object
    required
    • resource
      object
      required
      • kind
        string
        required
      • id
        string
        required
    • channel
      string
      required
    • tier_id
      required

      One of the following:

      • string
      • null
    • closed
      boolean
      required
  • author
    required

    Who signs it, or null when unsigned.

    One of the following:

    • object
    • object
    • null
  • created
    array of
    object
    required

    The attachments the write bound: the files a new teaser names.

    • id
      string
      required
    • role
      string
      required
    • asset
      object
      required
      • id
        string
        required
  • preview
    optional

    The teaser, in the rich text format as stored; answered only with full.

    One of the following:

    • string
    • null
  • attachments
    optional
    array of
    object

    Every attachment on the entry with its asset whole; answered only with full.

    • id
      string
      required
    • target
      object
      required
      • kind
        string
        required
      • id
        string
        required
    • role
      string
      required
    • delivery
      string
      required
    • preview_only
      boolean
      required
    • from_body
      boolean
      required
    • release_file
      boolean
      required

      A file a software release ships, which its release edits and the product's own list leaves out.

    • position
      number
      required
    • asset
      object
      required
      • id
        string
        required
      • locator
        required

        One of the following:

        • string
        • null
      • origin
        string
        required
      • custodian
        string
        required
      • enforcement
        string
        required
      • mime
        required

        One of the following:

        • string
        • null
      • bytes
        required

        The file's size in bytes; null when it is charged nothing.

        One of the following:

        • number
        • null
      • quota_bytes
        number
        required

        The file's size in bytes; zero when it is charged nothing.

      • name
        string
        required
      • title
        required

        One of the following:

        • string
        • null
      • ext
        required

        One of the following:

        • string
        • null
      • status
        string
        required
      • optimized
        boolean
        required
      • parent_id
        required

        One of the following:

        • string
        • null
      • redacted
        boolean
        required
      • security
        required

        One of the following:

        • string
        • null
      • description
        required

        One of the following:

        • string
        • null
      • processed_at
        required

        One of the following:

        • string
        • null
      • metadata
        object
        required
        • width
          optional
          integer
          minimum: 0
        • height
          optional
          integer
          minimum: 0
        • duration
          optional
          number

          Seconds, measured, so rarely whole.

        • pages
          optional
          integer
          minimum: 0
        • waveform
          optional

          An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.

          One of the following:

          • string
          • null
        • transcript
          optional
          object
          • language
            optional
            string
          • confidence
            optional
            number
        • arguments
          optional
          array of
          object

          What an MCP prompt asks for; only an authored prompt carries it.

          • name
            string
            required
          • description
            required

            One of the following:

            • string
            • null
          • required
            boolean
            required
          • default
            required

            One of the following:

            • string
            • null
          • match
            required

            Pattern the whole value must match, diacritic-insensitive.

            One of the following:

            • string
            • null
          • flags
            required

            Flags among i, s and u the pattern runs with; null for i alone.

            One of the following:

            • string
            • null
          • message
            required

            What a refused value is told instead of the default reason.

            One of the following:

            • string
            • null
          • lenient
            boolean
            required
      • created_at
        required

        One of the following:

        • string
        • null
  • files
    optional
    map of
    object

    The files its teaser names, and every other file it binds; answered only with full.

  • quizzes
    optional
    object

    Its quiz versions, the current one first; answered only with full.

    • items
      array of
      object
      required
      • id
        string
        required
      • entry_id
        string
        required
      • product_id
        string
        required
      • version
        number
        required
      • settings
        object
        required
        • attempts_allowed
          required

          One of the following:

          • number
          • null
        • pass_mark
          required

          One of the following:

          • number
          • null
        • show_answers
          boolean
          required
      • created_at
        required

        One of the following:

        • string
        • null
      • updated_at
        required

        One of the following:

        • string
        • null
    • total
      number
      required
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close