Rename, lock, reorder or move a board

PATCH /boards/{boardId}

Updated 16 Sep 20262 min read

PATCH/boards/{boardId}Try it

Basehttps://api.mockflow.com/v1Scopesboards:write

Request

curl https://api.mockflow.com/v1/boards/brd_3f9e2a \
  -X PATCH \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Q4 Launch Planning",
  "spaceId": "spc_92kd",
  "locked": false,
  "position": 0
}'

const response = await fetch("https://api.mockflow.com/v1/boards/brd_3f9e2a", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "title": "Q4 Launch Planning",
  "spaceId": "spc_92kd",
  "locked": false,
  "position": 0
})
});

const data = await response.json();

import os, requests

response = requests.patch(
    "https://api.mockflow.com/v1/boards/brd_3f9e2a",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
    json={
  "title": "Q4 Launch Planning",
  "spaceId": "spc_92kd",
  "locked": False,
  "position": 0
},
)

response.raise_for_status()
data = response.json()

Response

{
  "id": "brd_3f9e2a",
  "title": "Q4 Launch Planning",
  "spaceId": "spc_92kd",
  "url": "https://app.mockflow.com/board/3f9e2a",
  "publicUrl": "https://app.mockflow.com/board/brd_3f9e2a",
  "role": "owner"
}

{
  "error": {
    "code": "plan_limit",
    "message": "AI credits exhausted. 0 of 2000 remaining this month.",
    "upgradeUrl": "https://mockflow.com/pricing"
  },
  "requestId": "req_01ja"
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#rate_limited"
  },
  "requestId": "req_45d49816999bac40"
}

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.

Authorization

Authorizationstringheaderrequired

Bearer <key>. The key needs boards:write scope. Create and manage keys in the developer console; what each scope unlocks is on the scopes page.

Path parameters

boardIdstringpathrequired

Body

application/json

titlestring

spaceIdstring | null

A space id, or null / default for the default space.

lockedboolean

positioninteger

Response

200 · application/json

idstring

titlestring

spaceIdstring | null

The design space, or null for the default space.

urlstring

Opens the board in the editor.

publicUrlstring | null

The public viewer link, when the public link is on.

roleenum<string>

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. One of owner, admin, editor or reviewer.

lockedboolean

Locked boards are read only for everyone.

positioninteger | null

Manual order inside the space, lowest first.

createdBystring

createdAtstring

updatedAtstring

deletedAtstring | null

Set while the board is in the trash.

Errors

402plan_limit

The workspace plan does not allow this, or AI credits are exhausted.

429rate_limited

Too many requests.

Was this page helpful?