Skip to content
Navigation

Updates an MCP prompt's fields, text or access.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • prompt
    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

  • name
    optional
    string

    A slash command, unique among the store's prompts.

    maxLength: 64 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9-]*$
  • title
    optional
    string
    maxLength: 200 · minLength: 1
  • description
    optional

    One of the following:

    • string
    • null
  • body
    optional
    string

    The prompt's markdown: 100000 bytes of UTF-8, so a quarter as many characters always fit.

    maxLength: 25000 · minLength: 1
  • access
    optional

    One of the following:

    • object
    • null
  • arguments
    optional
    array of
    object
    • name
      string
      required
      maxLength: 64 · minLength: 1 · pattern: ^[A-Za-z_][A-Za-z0-9_-]*$
    • description
      optional

      One of the following:

      • string
      • null
    • required
      optional
      boolean

      A required argument takes no default.

    • default
      optional

      One of the following:

      • string
      • null
    • match
      optional

      Pattern the whole value must match, diacritic-insensitive.

      One of the following:

      • string
      • null
    • flags
      optional

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

      One of the following:

      • string
      • null
    • message
      optional

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

      One of the following:

      • string
      • null
    • lenient
      optional
      boolean

      Whether a value match refuses falls back to the default; only an argument with one.

Returns

200

Updates an MCP prompt's fields, text or access.

JSON
  • id
    string
    required
  • product_id
    string
    required
  • name
    string
    required
  • title
    required

    One of the following:

    • string
    • null
  • description
    required

    One of the following:

    • string
    • null
  • body
    string
    required
  • arguments
    array of
    object
    required
    • 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
  • access
    required

    One of the following:

    • object
    • null
  • position
    number
    required
  • created_at
    required

    One of the following:

    • string
    • null
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