Class BoardChanges

Hierarchy

  • BoardChanges

Constructors

constructor

Properties

description? name? policy? projectId? teamId?

Constructors

constructor

Properties

Optional description

description?: string

Description of the board.

Optional name

name?: string = 'Untitled'

Name for the board.

Optional policy

policy?: BoardPolicyChange

Optional projectId

projectId?: string

Unique identifier (ID) of the project to which the board must be added. Note: Projects have been renamed to Spaces. Use this parameter to update the space. For Starter and Edu plans, Team Admins looking to move boards between Spaces/Projects of the same team would need to be direct Board Editors on the boards to move.

Optional teamId

teamId?: string

Unique identifier (ID) of the team where the board must be placed. Note: On Enterprise plan, boards can be moved via API by Board Owners, Co-Owners, and Content Admins. This behavior differs from the Miro UI, where only Board Owners can move boards. This difference is intentional and works as designed. On non-Enterprise plans, only Board Owners can move boards between teams—both via the API and the Miro UI.

@mirohq/miro-api