Sign in

v1

latestOpenAPI 3.0.32026-07-12101432.4 KB
Kanban

patchKanbanBoard

Partially updates fields of an existing Kanban board by ID.

Only the fields provided in the request body will be updated. Useful for updating sharing settings, ownership, or title without replacing the full board configuration.

patch/v1/kanban/board/{boardId}

Path parameters

boardIdstring required

The ID of the board to patch.

Request body

titlestring
descriptionstring
shared_withstring[]

Array of user IDs to share the board with

shared_with_orgboolean

Whether the board is shared with the entire organization

ownersstring[]

Array of user IDs who have full ownership rights for this board (view, edit, delete)

Example request

{
  "title": "Board 1",
  "description": "Board description"
}

Response

Successfully patched board

idstring
titlestring required
descriptionstring
created_atstring date-time
updated_atstring date-time
created_bystring
org_idstring
updated_bystring
shared_withstring[]
shared_with_orgboolean
ownersstring[]

Array of user IDs who have full ownership rights for this board (view, edit, delete)

Example response

{
  "title": "Board 1",
  "description": "Board description",
  "config": {
    "dataset": "workflow_tasks_overview",
    "swimlanes": [
      {
        "title": "Swimlane 1",
        "position": 1,
        "filter": {
          "items": [
            {
              "key": "assignee",
              "operator": "EQUALS",
              "value": "100020",
              "data_type": "string"
            }
          ],
          "combination": "OR"
        },
        "title_chip_variant": "success"
      }
    ],
    "card_config": {
      "fields": [
        "assignee"
      ]
    },
    "board_filter": {
      "items": [
        {
          "key": "assignee",
          "operator": "EQUALS",
          "value": "100020",
          "data_type": "string"
        }
      ],
      "combination": "OR"
    },
    "sorting": {
      "field": "created_at"
    },
    "search_query": "task 1"
  }
}