Board
Update board identity fields
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).
patch/api/board/{boardId}/configuration/theme
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
boardIdstring required
Request body
Example request
{
"color": "#1ec968",
"icon": "fas fa-wrench"
}Response
The board's identity fields after the update.
Changes
No recorded changes to this operation across all 1 revision of this API.