storage
file

Update a file

Changed on
patch/storage/{connection_id}/file/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/storage/{connection_id}/file/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the File

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
descriptionstring
parent_idstring
user_idstring

(reference to HrisEmployee)

sizenumber
type'FILE' | 'FOLDER'
mime_typestring
download_urlstring

This link expires after 1 hour. When you need to retrieve the contents of a file, call the "Retrieve a file" endpoint again to get a new download_url.

hashstring
datastring

base64 encoded file contents used to create/update only

versionstring
web_urlstring
tagsstring[]

labels

rawobject

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
descriptionstring
parent_idstring
user_idstring

(reference to HrisEmployee)

sizenumber
type'FILE' | 'FOLDER'
mime_typestring
download_urlstring

This link expires after 1 hour. When you need to retrieve the contents of a file, call the "Retrieve a file" endpoint again to get a new download_url.

hashstring
datastring

base64 encoded file contents used to create/update only

versionstring
web_urlstring
tagsstring[]

labels

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the new optional request property

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • 1f72720916e4Revision changes
    • info

      added the new optional request property

    • info

      added the enum value tags to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status