Skip to content

Update attachment

Updates an attachment's role, delivery or preview flag.

Needs the file:write scope.

Call

  • Tool: update_attachment
  • Scope: file: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.
attachment object Yes
asset object No Swapped in place; on the store’s home only its body or stylesheet takes another file. A poster, and an image a product binds as embed, takes one of at most 15 MB.
from object No The asset the caller saw bound; any other refuses.
from_role "body" or "staged" or "staged_file" or "prose" or "teaser" or "embed" or "deliverable" or "poster" or "logo" or "prompt" or "stylesheet" No The role the caller saw it hold; another refuses.
from_delivery "inline" or "download" or "stream" No The delivery the caller saw it served by; another refuses.
body object or null No The body the caller saw on the target, null for none; another refuses.
kind "video" or "audio" or "pdf" No The file it holds after the write must be of this kind, as a lesson’s video swapped, or it refuses conflict on mime with the reason.
role "body" or "staged" or "staged_file" or "prose" or "teaser" or "embed" or "deliverable" or "poster" or "logo" or "prompt" or "stylesheet" No A move on the store’s home lands only in body or stylesheet; a poster, or an image moved into a product’s embed, is at most 15 MB.
delivery "inline" or "download" or "stream" No The seller’s pick, which a save of the text no longer flips with its use.
preview_only boolean No True drops every gate row of the attachment’s own, which takes the gate’s scopes.
position integer No
download_tier object or null No Who may download a lesson’s slides bound as a download: a tier and above, or null for whoever opens them; takes the gate’s scopes.
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "attachment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "asset": {
      "description": "Swapped in place; on the store's home only its body or stylesheet takes another file. A poster, and an image a product binds as `embed`, takes one of at most 15 MB.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "from": {
      "description": "The asset the caller saw bound; any other refuses.",
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      },
      "required": [
        "id"
      ],
      "additionalProperties": false
    },
    "from_role": {
      "description": "The role the caller saw it hold; another refuses.",
      "type": "string",
      "enum": [
        "body",
        "staged",
        "staged_file",
        "prose",
        "teaser",
        "embed",
        "deliverable",
        "poster",
        "logo",
        "prompt",
        "stylesheet"
      ]
    },
    "from_delivery": {
      "description": "The delivery the caller saw it served by; another refuses.",
      "type": "string",
      "enum": [
        "inline",
        "download",
        "stream"
      ]
    },
    "body": {
      "description": "The body the caller saw on the target, null for none; another refuses.",
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "kind": {
      "description": "The file it holds after the write must be of this kind, as a lesson's video swapped, or it refuses `conflict` on `mime` with the reason.",
      "type": "string",
      "enum": [
        "video",
        "audio",
        "pdf"
      ]
    },
    "role": {
      "description": "A move on the store's home lands only in `body` or `stylesheet`; a poster, or an image moved into a product's `embed`, is at most 15 MB.",
      "type": "string",
      "enum": [
        "body",
        "staged",
        "staged_file",
        "prose",
        "teaser",
        "embed",
        "deliverable",
        "poster",
        "logo",
        "prompt",
        "stylesheet"
      ]
    },
    "delivery": {
      "description": "The seller's pick, which a save of the text no longer flips with its use.",
      "type": "string",
      "enum": [
        "inline",
        "download",
        "stream"
      ]
    },
    "preview_only": {
      "description": "True drops every gate row of the attachment's own, which takes the gate's scopes.",
      "type": "boolean"
    },
    "position": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000
    },
    "download_tier": {
      "description": "Who may download a lesson's slides bound as a download: a tier and above, or null for whoever opens them; takes the gate's scopes.",
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "attachment"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
id string Yes
target object Yes
role string Yes
delivery string Yes
preview_only boolean Yes
from_body boolean Yes
release_file boolean Yes A file a software release ships, which its release edits and the product’s own list leaves out.
position number Yes
asset object 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