Skip to content

Update software activity

Updates a release's version, notes, files or tier, or a note.

Needs the product:write scope.

Call

  • Tool: update_software_event
  • Scope: product: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
event object Yes
body string or null No The release notes, as plain text.
files array of object No The store’s files this version ships, in order; each becomes a download of the product.
tier object or null No The lowest tier whose holders download its files; null or absent for every tier.
version string No A release’s version.
{
  "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
        }
      ]
    },
    "event": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "body": {
      "description": "The release notes, as plain text.",
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 10000
        },
        {
          "type": "null"
        }
      ]
    },
    "files": {
      "description": "The store's files this version ships, in order; each becomes a download of the product.",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1,
            "maxLength": 512
          }
        },
        "required": [
          "id"
        ],
        "additionalProperties": false
      },
      "maxItems": 20
    },
    "tier": {
      "description": "The lowest tier whose holders download its files; null or absent for every tier.",
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "version": {
      "description": "A release's version.",
      "type": "string",
      "minLength": 1,
      "maxLength": 50
    }
  },
  "required": [
    "product",
    "event"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
id string Yes
product_id string Yes
type string Yes release or note.
version string or null Yes A release’s version; null for a note.
body string or null Yes The release notes or the note, as plain text.
current boolean Yes Whether it is the product’s current download: its newest release that ships files.
files array of object Yes
tier object or null Yes The lowest tier whose holders download its files, while every file is gated to it; null for every tier.
push string Yes Its push: none never asked, pending owed, sent to its holders, or dropped for good (its files failed, or a newer release came first).
push_reason string or null Yes Why a dropped push was dropped: superseded, files (failed or never finished), removed (they left the release), unavailable (the product wasn’t open) or failed; null otherwise.
notified number Yes How many holders its push reached so far.
occurred_at string or null Yes
created_at string or null Yes
updated_at string or null Yes

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