Skip to content
Navigation

Renames a product's entry section.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/sections/rename

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    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 required

  • to
    required

    One of the following:

    • string
    • null
  • section
    optional

    One of the following:

    • string
    • null
  • section_id
    optional
    string
    maxLength: 64 · minLength: 1

Returns

200

Renames a product's entry section.

JSON
  • id
    string
    required
  • product_id
    string
    required
  • slug
    string
    required
  • 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
  • title
    string
    required
  • subtitle
    required

    One of the following:

    • string
    • null
  • section
    required

    One of the following:

    • string
    • null
  • author
    required

    Who signs it, or null when unsigned.

    One of the following:

    • object
    • object
    • null
  • tags
    array of
    string
    required
  • preview
    required

    The teaser, in the rich text format as stored.

    One of the following:

    • string
    • null
  • position
    number
    required
  • status
    string
    required
  • unlisted
    boolean
    required
  • published_at
    required

    One of the following:

    • string
    • null
  • unlisted_at
    required

    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
  • 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
  • search
    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
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