Add classification to folder

cURL

curl -i -X POST "https://api.box.com/2.0/folders/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "Box__Security__Classification__Key": "Sensitive"
     }'

await client.folderClassifications.addClassificationToFolder(folder.id, {
  requestBody: {
    boxSecurityClassificationKey: classification.key,
  } satisfies AddClassificationToFolderRequestBody,
} satisfies AddClassificationToFolderOptionalsInput);

{
  "Box__Security__Classification__Key": "Sensitive",
  "$parent": "folder_59449484661,",
  "$template": "securityClassification-6VMVochwUWo",
  "$scope": "enterprise_27335",
  "$version": 1,
  "$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
  "$typeVersion": 5,
  "$canEdit": true
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

POST

folders

{folder_id}

metadata

enterprise

securityClassification-6VMVochwUWo

cURL

curl -i -X POST "https://api.box.com/2.0/folders/12345/metadata/enterprise/securityClassification-6VMVochwUWo" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "Box__Security__Classification__Key": "Sensitive"
     }'

await client.folderClassifications.addClassificationToFolder(folder.id, {
  requestBody: {
    boxSecurityClassificationKey: classification.key,
  } satisfies AddClassificationToFolderRequestBody,
} satisfies AddClassificationToFolderOptionalsInput);

{
  "Box__Security__Classification__Key": "Sensitive",
  "$parent": "folder_59449484661,",
  "$template": "securityClassification-6VMVochwUWo",
  "$scope": "enterprise_27335",
  "$version": 1,
  "$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
  "$typeVersion": 5,
  "$canEdit": true
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

{
  "type": "error",
  "status": 400,
  "code": "item_name_invalid",
  "message": "Method Not Allowed",
  "context_info": {
    "message": "Something went wrong"
  },
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "request_id": "abcdef123456"
}

This endpoint is not available on the Free Developer Plan. Upgrade here.

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.

Path Parameters

folder_id

string

required

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123.

The root folder of a Box account is always represented by the ID 0.

Body

application/json

Box__Security__Classification__Key

string

The name of the classification to apply to this folder.

To list the available classifications in an enterprise, use the classification API to retrieve the classification template which lists all available classification keys.

Example:

"Sensitive"

Response

Returns the classification template instance that was applied to the folder.

An instance of the classification metadata template, containing the classification applied to the file or folder.

To get more details about the classification applied to an item, request the classification metadata template.

Box__Security__Classification__Key

string

The name of the classification applied to the item.

Example:

"Sensitive"

$parent

string

The identifier of the item that this metadata instance has been attached to. This combines the type and the id of the parent in the form {type}_{id}.

Example:

"folder_59449484661,"

$template

enum<string>

The value will always be securityClassification-6VMVochwUWo.

Available options:

securityClassification-6VMVochwUWo

Example:

"securityClassification-6VMVochwUWo"

$scope

string

The scope of the enterprise that this classification has been applied for.

This will be in the format enterprise_{enterprise_id}.

Example:

"enterprise_27335"

$version

integer

The version of the metadata instance. This version starts at 0 and increases every time a classification is updated.

Example:

1

$type

string

The unique ID of this classification instance. This will be include the name of the classification template and a unique ID.

Example:

"securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8"

$typeVersion

number

The version of the metadata template. This version starts at 0 and increases every time the template is updated. This is mostly for internal use.

Example:

5

$canEdit

boolean

Whether an end user can change the classification.

Example:

true

Last modified on August 25, 2026

API reference

API reference

API reference

Add classification to folder

Authorizations

Path Parameters

Body

Response