Skip to content
Navigation

Updates a file's name, title, description and security level.

PATCH
https://api.sherpo.io/merchant/v1/stores/{store}/assets/{asset}

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • asset
    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 optional

  • attachment
    optional
    object

    The binding the caller saw holding the file; one holding another refuses.

    • id
      string
      required
      maxLength: 512 · minLength: 1
  • locator
    optional
    string

    A link's URL; only a link held elsewhere takes one.

    maxLength: 100000 · minLength: 1
  • security
    optional

    The protection a stored PDF or spreadsheet is delivered with, refused for one no mark can be written into; null takes it off.

    One of the following:

    • string
    • null
  • name
    optional
    string
    maxLength: 200 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9-]*$
  • title
    optional

    One of the following:

    • string
    • null
  • description
    optional

    One of the following:

    • string
    • null
  • metadata
    optional
    object
    • transcript
      optional
      object
      • language
        optional
        string
        maxLength: 35 · minLength: 1
  • enforcement
    optional
    public
    or
    external
    or
    signed

    How the file is served: public to anyone with its link, signed (a stored file's default) only through links that expire, external for a link held elsewhere (a link's default).

  • mime
    optional

    A link's type; a stored file's is the one it was stored with.

    One of the following:

    • string
    • null
  • ext
    optional

    One of the following:

    • string
    • null
  • redacted
    optional
    boolean

Returns

200

Updates a file's name, title, description and security level.

JSON
  • transforms
    array of
    object
    required
    • stage
      string
      required
    • params
      object
      required
      • level
        optional
        string
    • position
      number
      required
  • deliveries
    object
    required
    • items
      array of
      object
      required
      • id
        string
        required
      • asset_id
        string
        required
      • customer_id
        required

        One of the following:

        • string
        • null
      • member_id
        required

        One of the following:

        • string
        • null
      • intent
        string
        required
      • channel
        string
        required
      • issued_at
        required

        One of the following:

        • string
        • null
      • expires_at
        required

        One of the following:

        • string
        • null
      • revoked_at
        required

        One of the following:

        • string
        • null
      • max_uses
        required

        One of the following:

        • number
        • null
      • used_count
        number
        required
      • used_at
        required

        One of the following:

        • string
        • null
      • state
        string
        required
    • total
      number
      required
  • uses
    object
    required
    • items
      array of
      object
      required
      • attachment_id
        string
        required
      • asset_id
        string
        required
      • role
        string
        required
      • delivery
        string
        required
      • target
        object
        required
        • kind
          string
          required
        • id
          string
          required
      • from_body
        boolean
        required
      • detachable
        boolean
        required
      • release
        required

        The software release shipping it, whether it is the current download, and the release holders download once it goes; null for a file no release ships.

        One of the following:

        • object
        • null
    • total
      number
      required
    • detachable
      number
      required
  • children
    object
    required
    • items
      array of
      string
      required
    • total
      number
      required
  • id
    string
    required
  • locator
    required

    One of the following:

    • string
    • null
  • origin
    string
    required
  • custodian
    string
    required
  • enforcement
    string
    required
  • mime
    required

    One of the following:

    • string
    • null
  • bytes
    required

    The file's size in bytes; null when it is charged nothing.

    One of the following:

    • number
    • null
  • quota_bytes
    number
    required

    The file's size in bytes; zero when it is charged nothing.

  • name
    string
    required
  • title
    required

    One of the following:

    • string
    • null
  • ext
    required

    One of the following:

    • string
    • null
  • status
    string
    required
  • optimized
    boolean
    required
  • parent_id
    required

    One of the following:

    • string
    • null
  • redacted
    boolean
    required
  • security
    required

    One of the following:

    • string
    • null
  • description
    required

    One of the following:

    • string
    • null
  • processed_at
    required

    One of the following:

    • string
    • null
  • metadata
    object
    required
    • width
      optional
      integer
      minimum: 0
    • height
      optional
      integer
      minimum: 0
    • duration
      optional
      number

      Seconds, measured, so rarely whole.

    • pages
      optional
      integer
      minimum: 0
    • waveform
      optional

      An audio file's waveform: 256 levels from 0 to 255, base64; null when it can't be drawn.

      One of the following:

      • string
      • null
    • transcript
      optional
      object
      • language
        optional
        string
      • confidence
        optional
        number
    • arguments
      optional
      array of
      object

      What an MCP prompt asks for; only an authored prompt carries it.

      • name
        string
        required
      • description
        required

        One of the following:

        • string
        • null
      • required
        boolean
        required
      • default
        required

        One of the following:

        • string
        • null
      • match
        required

        Pattern the whole value must match, diacritic-insensitive.

        One of the following:

        • string
        • null
      • flags
        required

        Flags among i, s and u the pattern runs with; null for i alone.

        One of the following:

        • string
        • null
      • message
        required

        What a refused value is told instead of the default reason.

        One of the following:

        • string
        • null
      • lenient
        boolean
        required
  • created_at
    required

    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