> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getaptly.com/llms.txt
> Use this file to discover all available pages before exploring further.

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




## OpenAPI

````yaml /openapi.yaml patch /api/board/{boardId}/configuration/theme
openapi: 3.0.3
info:
  title: Aptly API
  version: '1.1'
  description: |
    The Aptly API lets external systems work with boards, contacts, inboxes,
    tasks, files, and other Aptly resources.

    Most endpoints accept an API key in the `x-token` header. Some endpoints
    also accept a delegate token or partner bearer token, as shown in each
    operation's security requirements, and explicitly public endpoints require
    no credential. API keys are scoped to a company and may be restricted to
    specific boards and read, insert, or update permissions; requests outside
    those restrictions receive a 403 `FORBIDDEN` response.
servers:
  - url: https://core-api.getaptly.com
    description: Production
security:
  - ApiKeyHeader: []
paths:
  /api/board/{boardId}/configuration/theme:
    patch:
      tags:
        - Board
      summary: Update board identity fields
      description: >
        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.
      operationId: updateBoardTheme
      parameters:
        - name: boardId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                cardName:
                  type: string
                color:
                  type: string
                  example: '#1ec968'
                icon:
                  type: string
                  example: fas fa-wrench
                description:
                  type: string
                shortCode:
                  type: string
      responses:
        '200':
          description: The board's identity fields after the update.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      name:
                        type: string
                      cardName:
                        type: string
                      color:
                        type: string
                      icon:
                        type: string
                      description:
                        type: string
                      shortCode:
                        type: string
        '400':
          description: '`VALIDATION_ERROR` (per-field `meta.issues`) or a rule violation.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Invalid or missing API key.
        '403':
          description: >-
            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':
          description: Board (or field) not found.
      security:
        - ApiKeyHeader: []
        - PartnerBearer: []
components:
  schemas:
    ValidationError:
      type: object
      description: >
        Returned with HTTP 400 when the request body fails shape validation
        (wrong type,

        missing required field, malformed email/phone number, value out of
        bounds).

        `meta.issues` lists every offending field.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - VALIDATION_ERROR
            message:
              type: string
              example: One or more fields are invalid
            meta:
              type: object
              properties:
                issues:
                  type: array
                  items:
                    type: object
                    properties:
                      field:
                        type: string
                        description: >-
                          Dotted path to the offending property (for example
                          `to.0.value`); empty for a problem with the body as a
                          whole.
                        example: to.0.value
                      code:
                        type: string
                        description: >-
                          Machine-readable issue code (for example
                          `invalid_type`, `invalid_format`, `too_small`).
                        example: invalid_format
                      message:
                        type: string
                        example: must be a valid email address
        requestId:
          type: string
  securitySchemes:
    ApiKeyHeader:
      type: apiKey
      in: header
      name: x-token
    PartnerBearer:
      type: http
      scheme: bearer
      description: 'Partner token. Format: `Authorization: Bearer <token>`'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.