📄 Upload Files to Storage Deck via API

Upload Files to Storage Deck via API

This article explains how to upload files to the Storage Deck via an API request.


Requirements

Make sure that New Feature - Storage Deck is installed in the Upgrade Center.

A foundational knowledge and experience with APIs and API client applications like Postman are required.

⚠️

Postman will be used as samples for this guide. There may be some differences in the instructions when using other applications.


Single Upload

  1. Type the URL in the format <System URL>/storage/deck/upload and set the method to POST.


    💡

    You can get the System URL from the General Settings in your Strato Admin Tool.

  2. Go to the Authorization tab and set the Auth Type to Bearer Token. Fill in the Token field with your Bearer Token.


    💡

    Learn how to retrieve OAuth Token via API.

  3. Go to the Body tab. Set the request body to form-data and fill in the following details:


    Key
    Data Type
    Value
    file (Required)
    File

    Select files from your device.


    ❌

    There is a limit of 10MB for files.

    ✅

    The following file formats and extensions are supported:

    • .pdf
    • .jpg
    • .jpeg
    • .png
    • .bmp
    • .gif
    • .tiff
    • .ico
    • .svg
    • .webp
    • .doc
    • .docx
    • .xls
    • .xlsx
    • .rtf
    • .odt
    • .csv
    • .ods
    • .ppt
    • .pptx
    • .odp
    • .msg
    fileAssigneeUserId (Optional)
    Text
    Type in the username of the Recipient.

    The username can be obtained from User Management (V1) or People Hub (V2).


    fileAssigneeEmail (Optional)
    Text
    Type in the email address of the Recipient.

    The email can be obtained from People Hub.

    folderId (Optional)
    Text
    Type in the target folder ID, where the file will be placed when moving from the Storage Deck to Storage.

    The folder ID can be obtained from Storage Settings > Folder Management in V1.

    categoryId (Optional)
    Text
    Type in the Category ID for the file.

    The Category ID can be obtained from Storage Settings > Category Management in V1.

    fileNameOriginal (Optional)
    Text
    Type in the file name in the format <FileName>.<FileExtension>. If left empty, the uploaded file retains its original name.
    ❌

    The file will not be uploaded to the Storage Deck if the file extension here does not match the file extension of the uploaded file.

    ❌

    The fileAssigneeUserId and fileAssigneeEmail fields cannot be enabled (denoted by a checkmark) at the same time. To resolve this, disable or remove one of the fields.

    File Properties can also be added by adding more key-value pairs to the form.

    Key
    Data Type
    Value
    meta_[recordId] (Optional)

    The [recordId] can be obtained from the link in the address bar when viewing the details of the File Property.

    Text
    Type in the value to be associated with the file's Property.

  4. Click Send to send an API request to your URL with the information you filled in. If done correctly, the API should return a success message and the file should now be in your Storage Deck.



Batch Upload

Postman only allows for uploading one file at a time. To upload more than one file to the Storage Deck via API, contact our Support team for assistance.


Related articles