Create mind map node
POST/v2-experimental/boards/:board_id/mindmap_nodes
Adds a mind map node to a board. A root node is the starting point of a mind map. A node that is created under a root node is a child node. For information on mind maps, use cases, mind map structure, and more, see the Mind Map Overview page.
Required scope
boards:writeRate limiting
Level 2Known limitations on node placement: Currently, the create API supports explicit positions for nodes. This means that users can only place nodes based on the x, y coordinates provided in the position parameters. If the position is not provided in the request, nodes default to coordinates x=0, y=0, effectively placing them at the center of the board.
Upcoming changes: We understand the importance of flexibility in node placement. We are actively working on implementing changes to support positioning nodes relative to their parent node as well. This enhancement offers a more dynamic and intuitive mind mapping experience.
Additionally, we are actively working on providing the update API, further enhancing the functionality of mind map APIs.
Request
Path Parameters
Unique identifier (ID) of the board where you want to create the item.
- application/json
Body
required
data
object
required
Contains mind map node data, such as the title, content, or description.
nodeView
object
required
Contains information like data about the mind map node.
data
object
Contains the information about the mind map text.
Type of item used as mind map node. Currently, type
can only be equal to text
.
The actual text (content) that appears in the mind map node.
position
object
Contains information about the item's position on the board, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.
X-axis coordinate of the location of the item on the board.
By default, all items have absolute positioning to the board, not the current viewport. Default: 0.
The center point of the board has x: 0
and y: 0
coordinates.
Y-axis coordinate of the location of the item on the board.
By default, all items have absolute positioning to the board, not the current viewport. Default: 0.
The center point of the board has x: 0
and y: 0
coordinates.
geometry
object
Contains geometrical information about the item, such as its width or height.
Height of the item, in pixels.
Rotation angle of an item, in degrees, relative to the board. You can rotate items clockwise (right) and counterclockwise (left) by specifying positive and negative values, respectively.
Width of the item, in pixels.
parent
object
Contains information about the parent frame for the item.
Unique identifier (ID) of the parent frame for the item.
Responses
- 201
- 400
- 404
- 429
Mind map node created
- application/json
- Schema
- Example (from schema)
Schema
- TextData
Unique identifier (ID) of an item.
data
object
Contains mind map node data, such as nodeView
or isRoot
.
nodeView
object
Contains the information about the mind map node.
Type of item used as mind map node. Currently, type
can only be equal to text
.
data
object
Contains the mind map node data, such as the item title, content, or description.
oneOf
The actual text (content) that appears in the text item.
style
object
Contains information about the node style, such as the node color or fillOpacity.
Hex value representing the color for the text within the node.
It sets the opacity level of the background fill color.
Allowed values: any number between 0.0 and 1.0 included.
If the value is 0.0, the background fill color is completely transparent or invisible. If the value is 1.0, the background fill color is completely opaque or solid. Default: 0 (transparent)
Possible values: >= 10
and <= 288
Defines the font size, in dp, for the text on the node.
Default: 14
.
Indicates whether this node is the root of the mind map.
Possible values: [start
, end
]
Indicates where this node is positioned relative to the root node. start
indicates that this node must be positioned at the start of the root node, which is either the left or top of the root node. end
indicates that this node must be positioned at the emd of the root node, which is either the right or bottom of the root node.
Date and time when the item was created.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.
createdBy
object
Contains information about the user who created the item.
Unique identifier (ID) of the user.
Indicates the type of object returned. In this case, type
returns user
.
Date and time when the item was last modified.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.
modifiedBy
object
Contains information about the user who last modified the item.
Unique identifier (ID) of the user.
Indicates the type of object returned. In this case, type
returns user
.
parent
object
Contains information about the parent frame for the item.
Unique identifier (ID) of the parent frame for the item.
links
object
Contains applicable links for the current object.
Link to obtain more information about the current object.
links
object
Contains applicable links for the item.
Link to obtain information about the child items related to the frame.
Link to obtain information about the current item.
Type of item that is returned.
style
object
Contains information about the node style, such as the widget's border color or shape type.
Hex value representing the color of the widget's border.
Possible values: [pill
, rectangle
, rounded_rectangle
, none
]
Shape type of the widget.
Possible values: >= 10
and <= 288
The same font size as in MindmapNodeStyle.
{
"id": "3074457362577955300",
"data": {
"nodeView": {
"type": "text",
"data": {},
"style": {
"color": "#1a1a1a",
"fillOpacity": "string",
"fontSize": "string"
}
},
"isRoot": true,
"direction": "start"
},
"createdAt": "2024-04-11T15:04:04.287Z",
"createdBy": {
"id": "3458764517517852417",
"type": "user"
},
"modifiedAt": "2024-04-11T15:04:04.287Z",
"modifiedBy": {
"id": "3458764517517852417",
"type": "user"
},
"parent": {
"id": "3074457362577955300",
"links": {
"self": "http://api.miro.com/v2/boards/o9J_koQspF4=/object_type/3074457349143649487"
}
},
"links": {
"related": "http://api.miro.com/v2/boards/o9J_koQspF4=/items?parent_item_id=307445734914369434&limit=10&cursor=",
"self": "http://api.miro.com/v2/boards/o9J_koQspF4=/item/3074457349143649487"
},
"type": "string",
"style": {
"nodeColor": "#1a1a1a",
"shape": "pill",
"fontSize": "string"
}
}
Malformed request
- application/json
- Schema
- Example (from schema)
Schema
Code of the error
Description of the error
Status code of the error
Type of the error
{
"code": "error",
"message": "Error message",
"status": 400,
"type": "error"
}
Not found
- application/json
- Schema
- Example (from schema)
Schema
Code of the error
Description of the error
Status code of the error
Type of the error
{
"code": "error",
"message": "Error message",
"status": 400,
"type": "error"
}
Too many requests
- application/json
- Schema
- Example (from schema)
Schema
Code of the error
Description of the error
Status code of the error
Type of the error
{
"code": "error",
"message": "Error message",
"status": 400,
"type": "error"
}