---
title: "Update board metadata"
method: PATCH
path: "/boards/{board_id}"
tags: ["Boards"]
---

# Update board metadata

`PATCH /boards/{board_id}`

## Request

- Base URL: `https://api-docs.jackhamr.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.jackhamr.ai/boards/{board_id}`
- Auth: none declared

Update board metadata (name, description, status, accent, icon,
execution_mode). 404 when the board is not found or outside the org.

## Path parameters

- `board_id` string, required

## Request body

- BoardUpdate: Request body for ``PATCH /api/v1/boards/{id}``.
  - `name` string, nullable
  - `description` string, nullable
  - `status` string, nullable
  - `accent` string, nullable
  - `icon` string, nullable
  - `execution_mode` string, nullable
  - `orchestrator_skill_id` string, nullable

## Response `200`

Successful Response

- BoardOut: A board summary as returned by ``GET /api/v1/boards``.
  - `id` string, required
  - `name` string, required
  - `description` string, nullable
  - `accent` string, nullable
  - `icon` string, nullable
  - `status` string
  - `execution_mode` string
  - `orchestrator_skill_id` string, nullable
  - `is_virtual` boolean
  - `team` AgentRef[]
    - `id` string, required
    - `name` string, required
    - `status` string, nullable
    - `clone_of_agent_id` string, nullable
  - `card_count` integer
  - `done_count` integer
  - `waiting_count` integer
  - `progress` number
  - `created_at` string, date-time, nullable
  - `updated_at` string, date-time, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/jackhamr/apis/jackhamr-api.md) · [All operations](https://skmtc.dev/jackhamr/apis/jackhamr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/jackhamr/apis/jackhamr-api/revisions/f75d221481d8?raw)