Skip to content

Update feed reader limit

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

Needs the customer:write scope.

Call

  • Tool: update_feed
  • Scope: customer:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
store string No The store to act on.
product object Yes
feed object Yes
reader_limit integer or null Yes Readers it serves in 30 days before it moves to a new URL; null holds the default of 5.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "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
        }
      ]
    },
    "feed": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "reader_limit": {
      "description": "Readers it serves in 30 days before it moves to a new URL; null holds the default of 5.",
      "anyOf": [
        {
          "type": "integer",
          "minimum": 1,
          "maximum": 50
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "product",
    "feed",
    "reader_limit"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
id string Yes
customer_id string Yes
product_id string Yes
product object or null Yes
readers number Yes Readers it served in the last 30 days, each shared fetcher for the people it reports.
reader_limit number Yes Readers it serves in 30 days before it moves to a new URL.
reader_limit_set boolean Yes Whether the limit is the merchant’s own rather than the default.
created_at string or null Yes
revoked_at string or null Yes
revoked_reason string or null Yes 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.

The answer’s full shape is on its API reference page.

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 for every code and its context.

Type to search…

↑↓ navigate↵ selectEsc close