0

Force-apply metadata cascade policy to folder

by
Published Oct 17, 2025

Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. This can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.

Script box Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Box = {
3
  token: string;
4
};
5
/**
6
 * Force-apply metadata cascade policy to folder
7
 * Force the metadata on a folder with a metadata cascade policy to be applied to
8
all of its children. This can be used after creating a new cascade policy to
9
enforce the metadata to be cascaded down to all existing files within that
10
folder.
11
 */
12
export async function main(
13
  auth: Box,
14
  metadata_cascade_policy_id: string,
15
  body: { conflict_resolution: "none" | "overwrite" },
16
) {
17
  const url = new URL(
18
    `https://api.box.com/2.0/metadata_cascade_policies/${metadata_cascade_policy_id}/apply`,
19
  );
20

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