Skip to main content

Update board

PATCH 

/v2/boards/:board_id

Updates a specific board.

Required scope

boards:write

Rate limiting

Level 2

Request

Path Parameters

    board_id stringrequired

    Unique identifier (ID) of the board that you want to update.

Body

required

    description string

    Possible values: <= 300 characters

    Description of the board.

    name string

    Possible values: non-empty and <= 60 characters

    Default value: Untitled

    Name for the board.

    policy

    object

    Defines the permissions policies and sharing policies for the board.

    permissionsPolicy

    object

    Defines the permissions policies for the board.

    collaborationToolsStartAccess string

    Possible values: [all_editors, board_owners_and_coowners]

    Default value: all_editors

    Defines who can start or stop timer, voting, video chat, screen sharing, attention management. Others will only be able to join. To change the value for the collaborationToolsStartAccess parameter, contact Miro Customer Support.

    copyAccess string

    Possible values: [anyone, team_members, team_editors, board_owner]

    Default value: anyone

    Defines who can copy the board, copy objects, download images, and save the board as a template or PDF.

    sharingAccess string

    Possible values: [team_members_with_editing_rights, owner_and_coowners]

    Default value: team_members_with_editing_rights

    Defines who can change access and invite users to this board. To change the value for the sharingAccess parameter, contact Miro Customer Support.

    sharingPolicy

    object

    Defines the public-level, organization-level, and team-level access for the board. The access level that a user gets depends on the highest level of access that results from considering the public-level, team-level, organization-level, and direct sharing access.

    access string

    Possible values: [private, view, edit, comment]

    Default value: private

    Defines the public-level access to the board.

    inviteToAccountAndBoardLinkAccess string

    Possible values: [viewer, commenter, editor, no_access]

    Default value: no_access

    Defines the user role when inviting a user via the invite to team and board link. For Enterprise users, the inviteToAccountAndBoardLinkAccess parameter is always set to no_access regardless of the value that you assign for this parameter.

    organizationAccess string

    Possible values: [private, view, comment, edit]

    Default value: private

    Defines the organization-level access to the board. If the board is created for a team that does not belong to an organization, the organizationAccess parameter is always set to the default value.

    teamAccess string

    Possible values: [private, view, comment, edit]

    Default value: private

    Defines the team-level access to the board.

    teamId string

    Unique identifier (ID) of the team where the board must be placed.

    projectId string

    Unique identifier (ID) of the project to which the board must be added.

Responses

Board updated

Schema

    id stringrequired

    Unique identifier (ID) of the board.

    name stringrequired

    Name of the board.

    description stringrequired

    Description of the board.

    team

    object

    id stringrequired

    Team id

    name stringrequired

    Team name

    picture

    object

    id int64

    Id of the picture

    imageURL string

    Url of the picture

    originalUrl string

    Original team picture url for icon generation

    type string

    Default value: picture

    Type of the object returned.

    type string

    Default value: team

    Type of the object returned.

    project

    object

    id stringrequired

    Project ID.

    name stringrequired

    Name of the project.

    type stringrequired

    Default value: project

    Type of the object returned.

    picture

    object

    id int64

    Id of the picture

    imageURL string

    Url of the picture

    originalUrl string

    Original team picture url for icon generation

    type string

    Default value: picture

    Type of the object returned.

    policy

    object

    Defines the permissions policies and sharing policies for the board.

    permissionsPolicy

    object

    Defines the permissions policies for the board.

    collaborationToolsStartAccess string

    Possible values: [all_editors, board_owners_and_coowners]

    Default value: all_editors

    Defines who can start or stop timer, voting, video chat, screen sharing, attention management. Others will only be able to join. To change the value for the collaborationToolsStartAccess parameter, contact Miro Customer Support.

    copyAccess string

    Possible values: [anyone, team_members, team_editors, board_owner]

    Default value: anyone

    Defines who can copy the board, copy objects, download images, and save the board as a template or PDF.

    sharingAccess string

    Possible values: [team_members_with_editing_rights, owner_and_coowners]

    Default value: team_members_with_editing_rights

    Defines who can change access and invite users to this board. To change the value for the sharingAccess parameter, contact Miro Customer Support.

    sharingPolicy

    object

    Defines the public-level, organization-level, and team-level access for the board. The access level that a user gets depends on the highest level of access that results from considering the public-level, team-level, organization-level, and direct sharing access.

    access string

    Possible values: [private, view, edit, comment]

    Defines the public-level access to the board.

    inviteToAccountAndBoardLinkAccess string

    Possible values: [viewer, commenter, editor, coowner, owner, guest, no_access]

    Default value: no_access

    Defines the user role when inviting a user via the invite to team and board link. For Enterprise users, the inviteToAccountAndBoardLinkAccess parameter is always set to no_access.

    organizationAccess string

    Possible values: [private, view, comment, edit]

    Default value: private

    Defines the organization-level access to the board. If the board is created for a team that does not belong to an organization, the organizationAccess parameter is always set to the default value.

    teamAccess string

    Possible values: [private, view, comment, edit]

    Defines the team-level access to the board.

    viewLink string

    URL to view the board.

    owner

    object

    Contains information about the user who created the board.

    id stringrequired

    Unique identifier (ID) of the user.

    name stringrequired

    Name of the user.

    type stringrequired

    Indicates the type of object returned. In this case, type returns user.

    currentUserMembership

    object

    Contains the current user's board membership details. The current user could be different from the board owner.

    id stringrequired

    Unique identifier (ID) of the user.

    name stringrequired

    Name of the user.

    role string

    Possible values: [viewer, commenter, editor, coowner, owner]

    Role of the board member.

    type stringrequired

    Type of the object that is returned. In this case, type returns board_member.

    createdAt date-time

    Date and time when the board was created. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    createdBy

    object

    Contains information about the user who created the board.

    id stringrequired

    Unique identifier (ID) of the user.

    name stringrequired

    Name of the user.

    type stringrequired

    Indicates the type of object returned. In this case, type returns user.

    modifiedAt date-time

    Date and time when the board was last modified. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    modifiedBy

    object

    Contains information about the user who created the board.

    id stringrequired

    Unique identifier (ID) of the user.

    name stringrequired

    Name of the user.

    type stringrequired

    Indicates the type of object returned. In this case, type returns user.

    links

    object

    Contains applicable links for the board.

    related string

    Link to obtain information about the board members associated with the board.

    self string

    Link to obtain information about the current board.

    type stringrequired

    Type of the object that is returned. In this case, type returns board.

Loading...