Learn about the other types used when creating boards via the API
The monday.com boards API lets you query a board's content, settings, permissions, creator data, and more.
The object types below provide additional data structures used across the board API’s CRUD operations. They extend the core types documented in the main boards reference and are used to create and configure new boards, update board members, and retrieve detailed board information.
ItemNicknameInput
An object containing the item nickname.
| Field | Description |
|---|---|
plural String | The plural form of the item nickname |
preset_type String | The preset type for item nickname. |
singular String | The singular form of the item nickname. |
SetBoardPermissionResponse
An object containing the result of setting a board's permissions via the API.
Field | Description | Enum Values |
|---|---|---|
edit_permissions | Specifies which group of users is allowed to edit the board’s content. This setting reflects the board's technical editing permissions. |
|
failed_actions | Any actions that failed during the permission update process. |
UpdateBoardHierarchyAttributesInput
An object containing the board's attributes to update.
Field | Description | Supported Fields |
|---|---|---|
account_product_id | The board's updated account product ID. You must also provide the relevant | |
folder_id | The board's updated folder ID. | |
position | The board's updated position in the left-side menu. | is_after |
workspace_id | The board's updated workspace ID. |
Dynamic position
An object containing the board's updated position in the left-side menu of the platform.
Field | Description | Enum Values |
|---|---|---|
is_after | Specifies where to position the target board relative to the reference object:
| |
object_id | The unique identifier of the reference object that the target board should be positioned relative to. | |
object_type | The type of the reference object. |
|
UpdateBoardHierarchyResult
An object containing the result of updating a board's position, product, or workspace.
| Field | Description |
|---|---|
board Board | The updated board. |
message String | A message about the operation's result. |
success Boolean! | Whether the operation was successful. |
