Skip to main content
POST
/
metadata_templates
/
schema#classifications
Add initial classifications
curl -i -X POST "https://api.box.com/2.0/metadata_templates/schema" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "templateKey": "securityClassification-6VMVochwUWo",
       "scope": "enterprise",
       "displayName": "Classification",
       "hidden": false,
       "copyInstanceOnItemCopy": true,
       "fields": [
         {
           "type": "enum",
           "key": "Box__Security__Classification__Key",
           "displayName": "Classification",
           "hidden": false,
           "options": [
             {
               "key": "Classified",
               "staticConfig": {
                 "classification": {
                   "colorID": 7,
                   "classificationDefinition": "Top Seret"
                 }
               }
             }
           ]
         }
       ]
     }'
{
  "id": "58063d82-4128-7b43-bba9-92f706befcdf",
  "type": "metadata_template",
  "scope": "enterprise_123456",
  "templateKey": "securityClassification-6VMVochwUWo",
  "displayName": "Classification",
  "fields": [
    {
      "id": "822227e0-47a5-921b-88a8-494760b2e6d2",
      "type": "enum",
      "key": "Box__Security__Classification__Key",
      "displayName": "Classification",
      "options": [
        {
          "id": "46aea176-3483-4431-856c-6b5b13d1cc50",
          "key": "Sensitive",
          "staticConfig": {
            "classification": {
              "classificationDefinition": "Sensitive information",
              "colorID": 4
            }
          }
        }
      ],
      "hidden": false
    }
  ],
  "hidden": false,
  "copyInstanceOnItemCopy": true
}
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
​
scope
enum<string>
required

The scope in which to create the classifications. This should be enterprise or enterprise_{id} where id is the unique ID of the enterprise.

Available options:
enterprise
Example:

"enterprise"

​
templateKey
enum<string>
required

Defines the list of metadata templates.

Available options:
securityClassification-6VMVochwUWo
Example:

"securityClassification-6VMVochwUWo"

​
displayName
enum<string>
required

The name of the template as shown in web and mobile interfaces.

Available options:
Classification
Example:

"Classification"

​
fields
object[]
required

The classification template requires exactly one field, which holds all the valid classification values.

​
hidden
boolean

Determines if the classification template is hidden or available on web and mobile devices.

Example:

false

​
copyInstanceOnItemCopy
boolean

Determines if classifications are copied along when the file or folder is copied.

Example:

false

Response

Returns a new securityClassification metadata template, which contains a Box__Security__Classification__Key field that lists all the classifications available to this enterprise.

A metadata template that holds the security classifications defined by an enterprise.

​
id
string
required

The ID of the classification template.

Example:

"58063d82-4128-7b43-bba9-92f706befcdf"

​
type
enum<string>
required

The value will always be metadata_template.

Available options:
metadata_template
Example:

"metadata_template"

​
scope
string
required

The scope of the classification template. This is in the format enterprise_{id} where the id is the enterprise ID.

Example:

"enterprise_123456"

​
templateKey
enum<string>
required

The value will always be securityClassification-6VMVochwUWo.

Available options:
securityClassification-6VMVochwUWo
Example:

"securityClassification-6VMVochwUWo"

​
displayName
enum<string>
required

The name of this template as shown in web and mobile interfaces.

Available options:
Classification
Example:

"Classification"

​
fields
object[]
required

A list of fields for this classification template. This includes only one field, the Box__Security__Classification__Key, which defines the different classifications available in this enterprise.

Required array length: 1 element
​
hidden
boolean

Determines if the template is always available in web and mobile interfaces.

Example:

false

​
copyInstanceOnItemCopy
boolean

Determines if classifications are copied along when the file or folder is copied.

Example:

true