> ## 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 a field group

> Changes a group's `name`, `description` (an empty string clears it), `fieldUuids`, `required` or
`pinned`. Only the properties you send change; the group's subgroups and auto-assignment are left
as they are. `fieldUuids` replaces the group's field list, so send the full list in the order you
want. Requires `update` permission and "Edit Boards" access (not needed on a board that same key
created).




## OpenAPI

````yaml /openapi.yaml put /api/board/{boardId}/configuration/groups/{groupUuid}
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/groups/{groupUuid}:
    put:
      tags:
        - Board
      summary: Update a field group
      description: >
        Changes a group's `name`, `description` (an empty string clears it),
        `fieldUuids`, `required` or

        `pinned`. Only the properties you send change; the group's subgroups and
        auto-assignment are left

        as they are. `fieldUuids` replaces the group's field list, so send the
        full list in the order you

        want. Requires `update` permission and "Edit Boards" access (not needed
        on a board that same key

        created).
      operationId: updateBoardGroup
      parameters:
        - name: boardId
          in: path
          required: true
          schema:
            type: string
        - name: groupUuid
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              minProperties: 1
              properties:
                name:
                  type: string
                  maxLength: 100
                description:
                  type: string
                  maxLength: 500
                fieldUuids:
                  type: array
                  maxItems: 500
                  items:
                    type: string
                  description: >-
                    Uuids of fields on the board, in the order they should
                    appear in the group.
                required:
                  type: boolean
                pinned:
                  type: boolean
      responses:
        '200':
          description: The updated group.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
        '400':
          description: >-
            `VALIDATION_ERROR`, or a field uuid that isn't on the board or is
            listed twice.
          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, or
            the board isn't API-enabled.
        '404':
          description: Board or group 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
          description: >-
            Id of the request; also sent on every response as the `X-Request-Id`
            header.
  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.