Update a board
Update board name, description, visibility, status, or sort order. Requires `canUpdate{Creator|Reviewer}Board` for the board's visibility. Narrowing `visibility` when tasks, assignees or task relations depend on the removed tier returns 409 `boardVisibilityChangeBlocked`. Re-issue the request with `cascade: true` to apply the cleanup automatically (re-stamp tasks, unassign blocked assignees, delete blocked relations); the applied cleanup is reported in the response's `cascade` field.
Update board name, description, visibility, status, or sort order. Requires
canUpdate{Creator|Reviewer}Board for the board's visibility.
Narrowing visibility when tasks, assignees or task relations depend on the
removed tier returns 409 boardVisibilityChangeBlocked. Re-issue the request with
cascade: true to apply the cleanup automatically (re-stamp tasks, unassign blocked
assignees, delete blocked relations); the applied cleanup is reported in the
response's cascade field.
Authorization
bearerAuth In: header
Path Parameters
Unique identifier of the board
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
1 <= propertiesResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/boards/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8", "creatorId": "688ebf54-d343-4104-8711-82c2feac534a", "name": "string", "description": "string", "visibility": [ "creator" ], "status": "active", "pendingDeleteAt": "2019-08-24T14:15:22Z", "followers": [ "6021b93c-6a2e-4145-985c-40bb9e171532" ], "tags": [ "a424dc99-d215-4281-ad2d-a3a9bc179925" ], "sortOrder": 0, "inheritanceId": "09c886ac-e6e5-4263-a494-a6e14f7e4f46", "columns": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "boardId": "a654038e-9287-48a2-acfd-90b8cfa8b1f4", "name": "string", "description": "string", "color": "string", "isDefault": true, "taskStatus": "pending", "reviewersCanContribute": true, "sortOrder": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "cascade": { "restampedTaskIds": [ "7c7400c7-d45e-4faf-ae02-52ec1687870f" ], "unassignedTasks": [ { "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8", "assignedToId": "7a15e53b-1403-4928-9451-d7062c3a8737" } ], "removedRelationIds": [ "6086bac5-014e-4813-b3f4-a176afcbdc43" ] }}