sheets

Set sheet data classification

Changed on

Sets or updates the data classification on a sheet. The value must match one of the classification labels a plan admin has published in Admin Center; Requires sheet admin permissions and the sheet's plan must have data classification enabled.

put/sheets/{sheetId}/dataclassification

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: ADMIN_SHEETS

Headers

Content-Typestring

Required for POST and PUT requests. Defines the structure for the request body.

Request body

dataClassificationstring required

The name of a data classification label published in Admin Center for the sheet's plan. Matching against published labels is case-insensitive; the label's canonical name and color (as configured in Admin Center) are what get applied to the sheet.

justificationstring required

The justification for applying this data classification label to the sheet.

Example request

{
  "dataClassification": "Confidential",
  "justification": "Contains customer PII."
}

Response

OK

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3
  • '0' Success
  • '3' Partial Success of Bulk Operation

Example response

{
  "message": "SUCCESS"
}

Changes