---
title: "Update board identity fields"
method: PATCH
path: "/api/board/{boardId}/configuration/theme"
tags: ["Board"]
---

# Update board identity fields

`PATCH /api/board/{boardId}/configuration/theme`

## Request

- Base URL: `https://core-api.getaptly.com`
- URL: `https://core-api.getaptly.com/api/board/{boardId}/configuration/theme`
- Auth: one of:
  - API key in header `x-token`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/getaptly/apis/aptly-api/docs/api/board/:boardId/configuration/theme/patch.ts> (a function with typed inputs; its response is checked against the schema)

Updates any of the board's `name`, `cardName`, `color`, `icon`, `description` and `shortCode`;
at least one is required. `color` must be a hex color, `icon` a Font Awesome class string, and
`shortCode` 1-5 letters or numbers (stored uppercase). Requires `update` permission and the
key's "Edit Boards" access (not needed on a board that same key created).

## Path parameters

- `boardId` string, required

## Request body

- object
  - `name` string
  - `cardName` string
  - `color` string
  - `icon` string
  - `description` string
  - `shortCode` string

## Response `200`

The board's identity fields after the update.

- object
  - `data` object
    - `name` string
    - `cardName` string
    - `color` string
    - `icon` string
    - `description` string
    - `shortCode` string

## Other responses

- `400`: `VALIDATION_ERROR` (per-field `meta.issues`) or a rule violation.
- `401`: Invalid or missing API key.
- `403`: The key lacks `update` permission or the "Edit Boards" access, the board isn't API-enabled, or the field can't be changed (locked, standard, mirror or integration-managed).
- `404`: Board (or field) not found.

---

[API](https://skmtc.dev/getaptly/apis/aptly-api.md) - [All operations](https://skmtc.dev/getaptly/apis/aptly-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaptly/apis/aptly-api/revisions/75c367e0b8e5?raw)