---
title: "Rename, lock, reorder or move a board"
method: PATCH
path: "/boards/{boardId}"
tags: ["Boards"]
---

# Rename, lock, reorder or move a board

`PATCH /boards/{boardId}`

## Request

- Base URL: `https://api.mockflow.com/v1`
- URL: `https://api.mockflow.com/v1/boards/{boardId}`
- Auth: HTTP bearer

Rename and lock need admin. Lock makes the board read only for everyone, the padlock in the
dashboard, and needs Plus or Max. Move is the owning workspace's and needs Plus or Max; as in
the app, every direct board share is dropped when a board moves, and access then follows the
destination space. Moving into a space another workspace owns is not supported.

## Request body

- object
  - `title` string
  - `spaceId` string, nullable: A space id, or null / `default` for the default space.
  - `locked` boolean
  - `position` integer

## Response `200`

OK

- Board
  - `id` string
  - `title` string
  - `spaceId` string, nullable: The design space, or null for the default space.
  - `url` string, uri: Opens the board in the editor.
  - `publicUrl` string, uri, nullable: The public viewer link, when the public link is on.
  - `role` 'owner' | 'admin' | 'editor' | 'reviewer': The product's roles. Owner is the workspace that holds the board or space and cannot be granted or transferred. Admin can rename and share, editor can edit, reviewer can view, export and add comment items. There is no viewer role and no pending state.
  - `locked` boolean: Locked boards are read only for everyone.
  - `position` integer, nullable: Manual order inside the space, lowest first.
  - `createdBy` string
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `deletedAt` string, date-time, nullable: Set while the board is in the trash.

## Other responses

- `402`: The workspace plan does not allow this, or AI credits are exhausted.
- `429`: Too many requests.

---

[API](https://skmtc.dev/mockflow/apis/mockflow-boards-api.md) - [All operations](https://skmtc.dev/mockflow/apis/mockflow-boards-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mockflow/apis/mockflow-boards-api/revisions/1a890390518c?raw)