---
title: "Reorder fields"
method: PUT
path: "/api/board/{boardId}/configuration/field-order"
tags: ["Board"]
---

# Reorder fields

`PUT /api/board/{boardId}/configuration/field-order`

## Request

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

Sets the order of a board's fields. Send the field `uuid`s in the order you want in `fields`.
The listed fields swap among the positions they already hold, so fields you leave out, and the
board's field groups, stay where they are. List every field to reorder the whole board.
Sending the current order changes nothing. Locked fields can be moved too. Refused (400) for an
unknown or repeated uuid. Returns every field of the board in its new order.
Requires `update` permission and "Edit Boards" access (not needed on a board that same key
created).

## Path parameters

- `boardId` string, required

## Request body

- object
  - `fields` string[], required: Field uuids in the order you want them.

## Response `200`

The board's fields in their new order.

- object
  - `data` object[]
    - `uuid` string
    - `name` string
    - `position` integer

## Other responses

- `400`: `VALIDATION_ERROR`, or a 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 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)