Skip to main content
POST
/
metadata_cascade_policies
cURL
curl -i -X POST "https://api.box.com/2.0/metadata_cascade_policies" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "folder_id": "12321",
       "scope": "enterprise_27335",
       "templateKey": "productInfo"
     }'
{
  "id": "6fd4ff89-8fc1-42cf-8b29-1890dedd26d7",
  "type": "metadata_cascade_policy",
  "owner_enterprise": {
    "type": "enterprise",
    "id": "690678"
  },
  "parent": {
    "type": "folder",
    "id": "1234567"
  },
  "scope": "enterprise_123456",
  "templateKey": "productInfo"
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
folder_id
string
required

The ID of the folder to apply the policy to. This folder will need to already have an instance of the targeted metadata template applied to it.

Example:

"1234567"

​
scope
enum<string>
required

The scope of the targeted metadata template. This template will need to already have an instance applied to the targeted folder.

Available options:
global,
enterprise
Example:

"enterprise"

​
templateKey
string
required

The key of the targeted metadata template. This template will need to already have an instance applied to the targeted folder.

In many cases the template key is automatically derived of its display name, for example Contract Template would become contractTemplate. In some cases the creator of the template will have provided its own template key.

Please list the templates for an enterprise, or get all instances on a file or folder to inspect a template's key.

Example:

"productInfo"

Response

Returns a new of metadata cascade policy.

A metadata cascade policy automatically applies a metadata template instance to all the files and folders within the targeted folder.

​
id
string
required

The ID of the metadata cascade policy object.

Example:

"6fd4ff89-8fc1-42cf-8b29-1890dedd26d7"

​
type
enum<string>
required

The value will always be metadata_cascade_policy.

Available options:
metadata_cascade_policy
Example:

"metadata_cascade_policy"

​
owner_enterprise
object

The enterprise that owns this policy.

​
parent
object

Represent the folder the policy is applied to.

​
scope
string

The scope of the metadata cascade policy can either be global or enterprise_*. The global scope is used for policies that are available to any Box enterprise. The enterprise_* scope represents policies that have been created within a specific enterprise, where * will be the ID of that enterprise.

Example:

"enterprise_123456"

​
templateKey
string

The key of the template that is cascaded down to the folder's children.

In many cases the template key is automatically derived of its display name, for example Contract Template would become contractTemplate. In some cases the creator of the template will have provided its own template key.

Please list the templates for an enterprise, or get all instances on a file or folder to inspect a template's key.

Example:

"productInfo"