Update a board's layout

PUT /io/board/:boardId/layout

Update a board's layout by replacing the entire layout object.

Requires at least manager role on the board specified.

Example Request Body

01{
02    "lanes": [
03        {
04            "id": "10113986293",
05            "title": "Not Started - Future Work",
06            "type": "ready",
07            "classType": "backlog",
08            "index": 0,
09            "columns": 3,
10            "orientation": "vertical",
11            "isConnectionDoneLane": false,
12            "isDefaultDropLane": false,
13            "children": [
14                {
15                    "id": "10113986298",
16                    "title": "New Requests",
17                    "type": "ready",
18                    "classType": "backlog",
19                    "index": 0,
20                    "columns": 1,
21                    "orientation": "vertical",
22                    "isConnectionDoneLane": false,
23                    "isDefaultDropLane": true,
24                    "children": [],
25                    "wipLimit": 0,
26                    "description": null
27                }
28            ],
29            "wipLimit": 0,
30            "description": null
31        },
32        {
33            "id": "10113986295",
34            "title": "Doing Now",
35            "type": "inProcess",
36            "classType": "active",
37            "index": 1,
38            "columns": 2,
39            "orientation": "vertical",
40            "isConnectionDoneLane": false,
41            "isDefaultDropLane": false,
42            "children": [],
43            "wipLimit": 0,
44            "description": null
45        },
46        {
47            "title": "NEW LANE",
48            "type": "untyped",
49            "classType": "active",
50            "index": 4,
51            "columns": 1,
52            "orientation": "vertical",
53            "isConnectionDoneLane": false,
54            "isDefaultDropLane": false,
55            "children": [],
56            "wipLimit": 0
57        },
58        {
59            "id": "10113986294",
60            "title": "Finished - Ready to Archive",
61            "type": "completed",
62            "classType": "archive",
63            "index": 6,
64            "columns": 3,
65            "orientation": "vertical",
66            "isConnectionDoneLane": false,
67            "isDefaultDropLane": false,
68            "children": [],
69            "wipLimit": 0,
70            "description": null
71        }
72    ],
73    "layoutChecksum": "2f03a0170a3a51b45e0e8fa3710cf755"
74}

Notes

The lanes object and layoutChecksum are retrieved via the board GET endpoint
The layoutChecksum is used to validate that the board layout has not been edited by another user since it was last retrieved.

Example Successful Response

200 Success

01{
02    "lanes": [
03        {
04            "id": "10113986293",
05            "title": "Not Started - Future Work",
06            "wipLimit": 0,
07            "columns": 3,
08            "orientation": "vertical",
09            "index": 0,
10            "type": "ready",
11            "classType": "backlog",
12            "cardStatus": "notStarted",
13            "description": null,
14            "isConnectionDoneLane": false,
15            "isDefaultDropLane": false,
16            "children": [
17                {
18                    "id": "10113986298",
19                    "title": "New Requests",
20                    "wipLimit": 0,
21                    "columns": 1,
22                    "orientation": "vertical",
23                    "index": 0,
24                    "type": "ready",
25                    "classType": "backlog",
26                    "cardStatus": "notStarted",
27                    "description": null,
28                    "isConnectionDoneLane": false,
29                    "isDefaultDropLane": true
30                }
31            ]
32        },
33        {
34            "id": "10113986295",
35            "title": "Doing Now",
36            "wipLimit": 0,
37            "columns": 2,
38            "orientation": "vertical",
39            "index": 1,
40            "type": "inProcess",
41            "classType": "active",
42            "cardStatus": "started",
43            "description": null,
44            "isConnectionDoneLane": false,
45            "isDefaultDropLane": false
46        },
47        {
48            "id": "10113989209",
49            "title": "NEW LANE",
50            "wipLimit": 0,
51            "columns": 1,
52            "orientation": "vertical",
53            "index": 2,
54            "type": "untyped",
55            "classType": "active",
56            "cardStatus": "started",
57            "description": null,
58            "isConnectionDoneLane": false,
59            "isDefaultDropLane": false
60        },
61        {
62            "id": "10113986296",
63            "title": "Recently Finished",
64            "wipLimit": 0,
65            "columns": 2,
66            "orientation": "vertical",
67            "index": 3,
68            "type": "completed",
69            "classType": "active",
70            "cardStatus": "finished",
71            "description": null,
72            "isConnectionDoneLane": true,
73            "isDefaultDropLane": false
74        },
75        {
76            "id": "10113986294",
77            "title": "Finished - Ready to Archive",
78            "wipLimit": 0,
79            "columns": 3,
80            "orientation": "vertical",
81            "index": 4,
82            "type": "completed",
83            "classType": "archive",
84            "cardStatus": "finished",
85            "description": null,
86            "isConnectionDoneLane": false,
87            "isDefaultDropLane": false
88        }
89    ],
90    "layoutChecksum": "b41c4d1deb7e46b2180a636020b2e5cf"
91}