Skip to main content

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:write

Rate limiting

Level 2

Known 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

    board_id stringrequired

    Unique identifier (ID) of the board where you want to create the item.

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 stringrequired

    Type of item used as mind map node. Currently, type can only be equal to text.

    content string

    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 double

    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 double

    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 double

    Height of the item, in pixels.

    rotation double

    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 double

    Width of the item, in pixels.

    parent

    object

    Contains information about the parent frame for the item.

    id int64

    Unique identifier (ID) of the parent frame for the item.

Responses​

Mind map node created

Schema

    id int64required

    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 string

    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

    content stringrequired

    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.

    color string

    Hex value representing the color for the text within the node.

    fillOpacity string

    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)

    fontSize string

    Possible values: >= 10 and <= 288

    Defines the font size, in dp, for the text on the node. Default: 14.

    isRoot boolean

    Indicates whether this node is the root of the mind map.

    direction string

    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.

    createdAt date-time

    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.

    id string

    Unique identifier (ID) of the user.

    type string

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

    modifiedAt date-time

    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.

    id string

    Unique identifier (ID) of the user.

    type string

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

    parent

    object

    Contains information about the parent frame for the item.

    id int64

    Unique identifier (ID) of the parent frame for the item.

    links

    object

    Contains applicable links for the current object.

    self string

    Link to obtain more information about the current object.

    links

    object

    Contains applicable links for the item.

    related string

    Link to obtain information about the child items related to the frame.

    self string

    Link to obtain information about the current item.

    type stringrequired

    Type of item that is returned.

    style

    object

    Contains information about the node style, such as the widget's border color or shape type.

    nodeColor string

    Hex value representing the color of the widget's border.

    shape string

    Possible values: [pill, rectangle, rounded_rectangle, none]

    Shape type of the widget.

    fontSize string

    Possible values: >= 10 and <= 288

    The same font size as in MindmapNodeStyle.

Loading...