Board Mutations

Board mutations allow you to make changes or add to boards data on your Quabbly database account. This pertains to creating, updating and deleting a board from your account.

Create a Board

To create a board you need to pass a mutation query as the operator and board as operation name. This operation takes the createBoardDTO and corresponding object properties as an argument in its request body.

operator name : board

📘

Note

Refer to Boards section for a comprehensive list of arguments and fields to add to your GraphQl request.

GraphQL

mutation {
  board(
    createBoardDTO: {
      name: "Venture Deals"
      description: "This a Venture Deal flow board"
      size: SMALL
    }
  ) {
    id
    boardSecret {
      name
      description
      boardSize
    }
    createdBy
    createdTime
    lastUpdatedTime
  }
}

Sample Response

{
    "data": {
        "board": {
            "id": "6170cc16354d40000159ca1d",
            "boardSecret": {
                "name": "Venture Deals",
                "description": "This a Venture Deal flow board",
                "boardSize": "SMALL"
            },
            "createdBy": "Praise Adediji",
            "createdTime": "Thu Oct 21 02:10:30 GMT 2021",
            "lastUpdatedTime": null
        }
    }
}

Update Board

The operation updateBoard allows you to make changes to properties such as name, description, size and default view of a board. It takes the boardId, updateBoardDTO and its corresponding object properties as an argument in its request body.

operator name : updateBoard

GraphQL

mutation{
    updateBoard (
    boardId:"6170cc16354d40000159ca1d"
    updateBoardDTO:{
        name: "Deals"
        description: "This a Venture Deal flow board"
        size: MEDIUM
    }) {
        id
        boardSecret {
            name
            description
            boardSize
        }
        createdBy
        createdTime
        lastUpdatedTime
    }
}

Sample Response

{
    "data": {
        "updateBoard": {
            "id": "6170cc16354d40000159ca1d",
            "boardSecret": {
                "name": "Deals",
                "description": "This a Venture Deal flow board",
                "boardSize": "MEDIUM"
            },
            "createdBy": "Praise Adediji",
            "createdTime": "Thu Oct 21 02:10:30 GMT 2021",
            "lastUpdatedTime": null
        }
    }
}

Delete Board

The operation deleteBoard allows you to remove a board from database on your account. It takes only the boardId as argument. No fields is passed in the query body.

operator name : deleteBoard

GraphQL

mutation {
    deleteBoard(
        boardId:"6152bd1cee3a6e000130edb9"
    )
}

Sample Response

{
    "data": {
        "deleteBoard": "SUCCESS"
    }
}

Next up, let's see how to create a duplicate board.