On this page
You are reading the documentation of FileRun 2026.4.0, which is not released yet. It is subject to change, so do not use it for planning. Read this page for FileRun 2026.3.0
The API
API Methods
Files methods
Setting metadata
API: Setting metadata🔗
Target URL
/api.php/Drive/files/metadata/set
Required scope
metadata
HTTP Method
POST
Output format
JSON
Request Parameters Reference🔗
Parameter
Type
Required
Description
path
string
Yes
See this page
file_type_name
string
No
The name of an existing metadata file type (such as Documents, Photos, Audio, Videos or user defined.)
fields
array
Yes
The keys need to be ids of existing metadata fields. The values can be either strings or an arrays of strings for multivalue fields.
The response🔗
The response contains the results array with information for each submitted field:
Field
Type
Description
success
boolean
true if the value was set, false if not.
field_id
integer
The metadata field id, for reference.
field_name
string
The name of the field, for reference.
status
string
The result of the action (which can be skipped, updated, set or deleted)
msg
string
The textual description of the result of the action.
oldValue
string or array
Self-explanatory
newValue
string or array
Self-explanatory