Columns - Update

Update columns on a board

PUT https://{accountName}.visualstudio.com/{project}/{team}/_apis/work/boards/{board}/columns?api-version=4.1

URI Parameters

Name In Required Type Description
accountName
path True
  • string

The name of the Visual Studio Team Services account.

project
path True
  • string

Project ID or project name

team
path
  • string

Team ID or team name

board
path True
  • string

Name or ID of the specific board

api-version
query True
  • string

Version of the API to use. This should be set to '4.1' to use this version of the api.

Request Body

Name Required Type Description
columnType
description
  • string
id
  • string
isSplit
  • boolean
itemLimit
  • integer
name
  • string
stateMappings
  • object

Responses

Name Type Description
200 OK

successful operation

Examples

Update columns on a board

Sample Request

PUT https://fabrikam.visualstudio.com/Fabrikam/Fabrikam Team/_apis/work/boards/{board}/columns?api-version=4.1
[
  {
    "id": "12eed5fb-8af3-47bb-9d2a-058fbe7e1196",
    "name": "New",
    "itemLimit": 0,
    "stateMappings": {
      "Product Backlog Item": "New",
      "Bug": "New"
    },
    "columnType": "incoming"
  },
  {
    "id": "5f72391d-af1c-4754-9459-23138eba13e3",
    "name": "Approved",
    "itemLimit": 5,
    "stateMappings": {
      "Product Backlog Item": "Approved",
      "Bug": "Approved"
    },
    "isSplit": false,
    "description": "",
    "columnType": "inProgress"
  },
  {
    "id": "4ddb0875-547e-4d2c-b36a-4ea9a1f7be41",
    "name": "Committed",
    "itemLimit": 5,
    "stateMappings": {
      "Product Backlog Item": "Committed",
      "Bug": "Committed"
    },
    "isSplit": false,
    "description": "",
    "columnType": "inProgress"
  },
  {
    "id": "1016c466-6cb6-4bf9-9a19-4e9cc88204df",
    "name": "Done",
    "itemLimit": 0,
    "stateMappings": {
      "Product Backlog Item": "Done",
      "Bug": "Done"
    },
    "columnType": "outgoing"
  }
]

Sample Response

{
  "count": 4,
  "value": [
    {
      "id": "12eed5fb-8af3-47bb-9d2a-058fbe7e1196",
      "name": "New",
      "itemLimit": 0,
      "stateMappings": {
        "Product Backlog Item": "New",
        "Bug": "New"
      },
      "columnType": "incoming"
    },
    {
      "id": "5f72391d-af1c-4754-9459-23138eba13e3",
      "name": "Approved",
      "itemLimit": 5,
      "stateMappings": {
        "Product Backlog Item": "Approved",
        "Bug": "Approved"
      },
      "isSplit": false,
      "description": "",
      "columnType": "inProgress"
    },
    {
      "id": "4ddb0875-547e-4d2c-b36a-4ea9a1f7be41",
      "name": "Committed",
      "itemLimit": 5,
      "stateMappings": {
        "Product Backlog Item": "Committed",
        "Bug": "Committed"
      },
      "isSplit": false,
      "description": "",
      "columnType": "inProgress"
    },
    {
      "id": "1016c466-6cb6-4bf9-9a19-4e9cc88204df",
      "name": "Done",
      "itemLimit": 0,
      "stateMappings": {
        "Product Backlog Item": "Done",
        "Bug": "Done"
      },
      "columnType": "outgoing"
    }
  ]
}

Definitions

BoardColumn
BoardColumnType

BoardColumn

Name Type Description
columnType
description
  • string
id
  • string
isSplit
  • boolean
itemLimit
  • integer
name
  • string
stateMappings
  • object

BoardColumnType

Name Type Description
inProgress
  • string
incoming
  • string
outgoing
  • string