---
title: "Add initial classifications"
method: POST
path: "/metadata_templates/schema#classifications"
tags: ["Classifications"]
---

# Add initial classifications

`POST /metadata_templates/schema#classifications`

When an enterprise does not yet have any classifications, this API call
initializes the classification template with an initial set of
classifications.

If an enterprise already has a classification, the template will already
exist and instead an API call should be made to add additional
classifications.

## Request body

- object
  - `scope` 'enterprise', 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.
  - `templateKey` 'securityClassification-6VMVochwUWo', required — Defines the list of metadata templates.
  - `displayName` 'Classification', required — The name of the template as shown in web and mobile interfaces.
  - `hidden` boolean — Determines if the classification template is hidden or available on web and mobile devices.
  - `copyInstanceOnItemCopy` boolean — Determines if classifications are copied along when the file or folder is copied.
  - `fields` object[], required — The classification template requires exactly one field, which holds all the valid classification values.
    - `type` 'enum', required — The type of the field that is always enum.
    - `key` 'Box__Security__Classification__Key', required — Defines classifications available in the enterprise.
    - `displayName` 'Classification', required — A display name for the classification.
    - `hidden` boolean — Determines if the classification template is hidden or available on web and mobile devices.
    - `options` object[], required — The actual list of classifications that are present on this template.
      - `key` string, required — The display name and key this classification. This will be show in the Box UI.
      - `staticConfig` object — Additional information about the classification.
        - `classification` object — Additional information about the classification.
          - `classificationDefinition` string — A longer description of the classification.
          - `colorID` integer — An identifier used to assign a color to a classification label. Mapping between a `colorID` and a color may change without notice. Currently, the color mappings are as follows. * `0`: Yellow. * `1`: Orange. * `2`: Watermelon red. * `3`: Purple rain. * `4`: Light blue. * `5`: Dark blue. * `6`: Light green. * `7`: Gray.

## Response `200`

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

- ClassificationTemplate — A metadata template that holds the security classifications defined by an enterprise.
  - `id` string, required — The ID of the classification template.
  - `type` 'metadata_template', required — The value will always be `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.
  - `templateKey` 'securityClassification-6VMVochwUWo', required — The value will always be `securityClassification-6VMVochwUWo`.
  - `displayName` 'Classification', required — The name of this template as shown in web and mobile interfaces.
  - `hidden` boolean — Determines if the template is always available in web and mobile interfaces.
  - `copyInstanceOnItemCopy` boolean — Determines if classifications are copied along when the file or folder is copied.
  - `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.
    - `id` string, required — The unique ID of the field.
    - `type` 'enum', required — The array item type.
    - `key` 'Box__Security__Classification__Key', required — Defines classifications available in the enterprise.
    - `displayName` 'Classification', required — The value will always be `Classification`.
    - `hidden` boolean — Classifications are always visible to web and mobile users.
    - `options` object[], required — A list of classifications available in this enterprise.
      - `id` string, required — The unique ID of this classification.
      - `key` string, required — The display name and key for this classification.
      - `staticConfig` object — Additional information about the classification.
        - `classification` object — Additional information about the classification. This is not an exclusive list of properties, and more object fields might be returned. These fields are used for internal Box Shield and Box Governance purposes and no additional value must be derived from these fields.
          - `classificationDefinition` string — A longer description of the classification.
          - `colorID` integer — An internal Box identifier used to assign a color to a classification label. Mapping between a `colorID` and a color may change without notice. Currently, the color mappings are as follows. * `0`: Yellow. * `1`: Orange. * `2`: Watermelon red. * `3`: Purple rain. * `4`: Light blue. * `5`: Dark blue. * `6`: Light green. * `7`: Gray.

## Other responses

- `400` — Returned if any of the request parameters are not valid.
- `404` — Returned when a template name is not correct. Please make sure the URL for the request is correct.
- `default` — An unexpected client error.

---

[API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)
