Create a Board

In iObeya, a Board is represented by the RoomBoard resource.

A RoomBoard corresponds to a board that belongs to a Room.

This article explains:

• How to create a board with the minimum required information

• How to create a board based on an existing model (BoardTemplate)

Prerequisites

To create a RoomBoard, you must know:

• the identifier of the room: roomId;

  • To retrieve rooms, you can use List all rooms.

• the name of the board to create: name.

Minimal RoomBoard creation

Request

POST /v1/roomBoards (See endpoint)

Body (JSON)

{
  "board": {
    "name": "My First Board"
  }
  "roomId": "ROOM_ID"
}

Expected result

If the request is successful, the API returns a representation of the newly created RoomBoard, including its unique identifier.
This identifier can then be used for further operations (sharing, configuration, content creation, etc.).

Create a RoomBoard from a model (BoardTemplate)

iObeya allows you to create a board based on a model (also called a board template).
The process consists of the following steps:

1. Retrieve the list of available board templates;

2. Select a template and extract its identifier;

3. Create the RoomBoard by providing this identifier via the modelId parameter.

Step A — List available board templates

POST /v1/board-templates/list (See endpoint)

This endpoint returns the list of board templates accessible to the current user.
From the response, identify the template identifier (used as modelId) and any relevant metadata such as the template name or description.

Step B — Create the RoomBoard using modelId

POST /v1/roomBoards

Body (JSON)

{
  "board": {
    "name": "My First Board"
  }
  "roomId": "ROOM_ID",
  "modelId": "BOARDTEMPLATE_ID"
}

Behavior

• The board is created inside the room identified by roomId.

• Its initial structure (layout, widgets, default configuration) is initialized from the specified model.

• The name field defines the name of the newly created board, independently of the template name.