Files

Update file

Update file metadata.

patch/api/files/{id}

Request

  • Base URL: https://docs.weavy.com (the document declares no server; this is the origin it was published from)
  • URL: https://docs.weavy.com/api/files/{id}
  • Auth: none declared

Path parameters

idinteger required

Id of file.

Request body

namestring nullable

The file name.

metadataobject nullable

Additional metadata properties, e.g. { "color": "blue", "size": "XL" }.

tagsstring[] nullable

A list of tags to associate with the file.

backupboolean

true to add previous version to version history, otherwise false (default).

Response

OK

namestring nullable
kindstring nullable
media_typestring nullable
metadataobject nullable
tagsstring[] nullable
providerstring nullable
rawstring nullable
download_urlstring nullable
application_urlstring nullable
embed_urlstring nullable
external_urlstring nullable
preview_format'none' | 'audio' | 'code' | 'embed' | 'html' | 'image' | 'pdf' | 'text' | 'video'
preview_urlstring nullable
thumbnail_urlstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable
is_starredboolean nullable
is_subscribedboolean nullable
is_trashedboolean nullable

Changes

No recorded changes to this operation across all 1 revision of this API.