Bulk update boards classification

PATCH 
/v2/orgs/:org_id/teams/:team_id/data-classification

Updates board classification for not-classified only or all boards in an existing team.

Required scope

boards:write

Rate limiting

Level 4

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using this form.

Request

Path Parameters

org_id stringrequired
id of the organization
Example: 3074457345821141000
team_id stringrequired
id of the team
Example: 3074457345618265000

application/json

Body

required

labelId int64

Data classification label id for team

notClassifiedOnly boolean

Assign data classification label to not-classified only or to all boards of team

Responses

200

Number of updated boards

application/json

Schema

Schema

numberUpdatedBoards int64

Number of boards updated in the team

type string

Default value: boards-data-classification-label-changed

Type of the object returned.

Example (from schema)

{
  "numberUpdatedBoards": 10,
  "type": "boards-data-classification-label-changed"
}

400

Malformed request

application/json

Schema

Schema

status number

Default value: 400

HTTP status code.

code string

Default value: invalidParameters

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 400,
  "code": "invalidParameters",
  "message": "string",
  "type": "error"
}

401

Invalid authentication credentials

application/json

Schema

Schema

status number

Default value: 401

HTTP status code.

code string

Default value: tokenNotProvided

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 401,
  "code": "tokenNotProvided",
  "message": "string",
  "type": "error"
}

403

Invalid access

application/json

Schema

Schema

status number

Default value: 403

HTTP status code.

code string

Default value: forbiddenAccess

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 403,
  "code": "forbiddenAccess",
  "message": "string",
  "type": "error"
}

404

Invalid access

application/json

Schema

Schema

status number

Default value: 404

HTTP status code.

code string

Default value: notFound

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 404,
  "code": "notFound",
  "message": "string",
  "type": "error"
}

429

Too many requests

application/json

Schema

Schema

status number

Default value: 429

HTTP status code.

code string

Default value: tooManyRequests

Description of the status code.

message string

Explanation for the error

type string

Default value: error

Type of the object returned.

Example (from schema)

{
  "status": 429,
  "code": "tooManyRequests",
  "message": "string",
  "type": "error"
}

Loading...