Kanban

patchKanbanBoard

Changed on Oct 26, 2026

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}

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 patch.

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

titlestring

descriptionstring

shared_with_orgboolean

Whether the board is shared with the entire organization. Ignored when org_access is provided.

org_access'view' | 'edit' | 'null' nullable

Org-wide access level. null removes org-wide sharing.

ownersstring[]

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

Example request

{
  "title": "Board 1",
  "description": "Board description",
  "shared_with": [
    {
      "user_id": "group_abc"
    }
  ]
}

Response

Successfully patched board

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 response

{
  "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"
  }
}

Changes

Oct 26, 2026246932aa9fd4 Revision changes
- warning
  added the new flow_template_id enum value to the /// response property for the response status
Oct 22, 20266857150b8f9b Revision changes
- breaking
  the / request property type changed from string to no type
- breaking
  added subschema #1 to the ///// response property oneOf list for the response status
- breaking
  the ///// response's property type changed from string to no type for status
- info
  added the new optional query request parameter shared_with_format
- info
  added the new optional request property
- info
  added subschema #1 to the / request property oneOf list
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status

Operation history