---
title: "Update a field group"
method: PUT
path: "/api/board/{boardId}/configuration/groups/{groupUuid}"
tags: ["Board"]
---

# Update a field group

`PUT /api/board/{boardId}/configuration/groups/{groupUuid}`

## Request

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

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

## Path parameters

- `boardId` string, required
- `groupUuid` string, required

## Request body

- object
  - `name` string
  - `description` string
  - `fieldUuids` string[]: Uuids of fields on the board, in the order they should appear in the group.
  - `required` boolean
  - `pinned` boolean

## Response `200`

The updated group.

- object
  - `data` object

## Other responses

- `400`: `VALIDATION_ERROR`, or a field uuid that isn't on the board or is listed twice.
- `401`: Invalid or missing API key.
- `403`: The key lacks `update` permission or the "Edit Boards" access, or the board isn't API-enabled.
- `404`: Board or group 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)