Kanban

updateKanbanBoard

Changed on Oct 26, 2026

Fully replaces the configuration of an existing Kanban board by ID.

All board fields (title, config, swimlanes, filters) must be provided. Use PATCH for partial updates.

put/v1/kanban/board/{boardId}

Request

Base URL
https://kanban.sls.epilot.io
URL
https://kanban.sls.epilot.io/v1/kanban/board/{boardId}
Auth
- HTTP bearer
- or API key in header x-epilot-org-id

Path parameters

boardIdstring required

The ID of the board to update.

Query parameters

shared_with_format'legacy' | 'grants'

Shape of shared_with in the response. legacy (default) returns plain principal ids; grants returns {user_id, permission} objects and is what clients that understand edit permissions should request.

Request body

idstring

titlestring required

descriptionstring

created_atstring date-time

updated_atstring date-time

created_bystring

org_idstring

updated_bystring

shared_with_orgboolean

Whether the board is shared with the whole organization (equivalent to org_access being set)

org_access'view' | 'edit'

Access level of a share. view is read-only. edit can additionally change the board configuration and title, but cannot delete the board, change sharing or change owners (owners only).

ownersstring[]

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

my_access'owner' | 'edit' | 'view'

Access level of the calling user. Only returned by getKanbanBoard.

Example request

{
  "title": "Board 1",
  "description": "Board description",
  "shared_with": [
    {
      "user_id": "group_abc"
    }
  ],
  "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"
  }
}

Response

Successfully updated board