0

Create metadata instance on file

by
Published Oct 17, 2025

Applies an instance of a metadata template to a file. In most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair.

Script box Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Box = {
3
  token: string;
4
};
5
/**
6
 * Create metadata instance on file
7
 * Applies an instance of a metadata template to a file.
8

9
In most cases only values that are present in the metadata template
10
will be accepted, except for the `global.properties` template which accepts
11
any key-value pair.
12
 */
13
export async function main(
14
  auth: Box,
15
  file_id: string,
16
  scope: "global" | "enterprise",
17
  template_key: string,
18
  body: {},
19
) {
20
  const url = new URL(
21
    `https://api.box.com/2.0/files/${file_id}/metadata/${scope}/${template_key}`,
22
  );
23

24
  const response = await fetch(url, {
25
    method: "POST",
26
    headers: {
27
      "Content-Type": "application/json",
28
      Authorization: "Bearer " + auth.token,
29
    },
30
    body: JSON.stringify(body),
31
  });
32
  if (!response.ok) {
33
    const text = await response.text();
34
    throw new Error(`${response.status} ${text}`);
35
  }
36
  return await response.json();
37
}
38