Boards

Rename, lock, reorder or move a board

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.

patch/boards/{boardId}

Request

  • Base URL
    https://api.mockflow.com/v1
  • Auth
    HTTP bearer

Request body

titlestring
spaceIdstring nullable

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

lockedboolean
positioninteger

Response

OK

idstring
titlestring
spaceIdstring nullable

The design space, or null for the default space.

urlstring uri

Opens the board in the editor.

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

lockedboolean

Locked boards are read only for everyone.

positioninteger nullable

Manual order inside the space, lowest first.

createdBystring
createdAtstring date-time
updatedAtstring date-time
deletedAtstring date-time nullable

Set while the board is in the trash.

Example response

{
  "id": "brd_3f9e2a",
  "url": "https://app.mockflow.com/board/3f9e2a"
}

Changes

No recorded changes to this operation across all 1 revision of this API.