Skip to content
Navigation

Sets how many readers a customer's private feed serves in 30 days before it moves to a new URL.

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

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

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

  • reader_limit
    required

    Readers it serves in 30 days before it moves to a new URL; null holds the default of 5.

    One of the following:

    • integer
    • null

Returns

200

Sets how many readers a customer's private feed serves in 30 days before it moves to a new URL.

JSON
  • id
    string
    required
  • customer_id
    string
    required
  • product_id
    string
    required
  • product
    required

    One of the following:

    • object
    • null
  • readers
    number
    required

    Readers it served in the last 30 days, each shared fetcher for the people it reports.

  • reader_limit
    number
    required

    Readers it serves in 30 days before it moves to a new URL.

  • reader_limit_set
    boolean
    required

    Whether the limit is the merchant's own rather than the default.

  • created_at
    required

    One of the following:

    • string
    • null
  • revoked_at
    required

    One of the following:

    • string
    • null
  • revoked_reason
    required

    Why it stopped: a new URL replaced it, too many readers shared it, its customer or the merchant revoked it, or the product turned private feeds off.

    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