Miro

App · Images & Design · 20 actions

Create and manage Miro boards. Add sticky notes, shapes, text, cards, frames and connectors, link items with connectors, and tag and organise items.

Actions

ActionWhat it does
Attach tag to itemAttach an existing tag to a card or sticky note.
Create boardCreate a new Miro board.
Create cardAdd a card - a task-shaped item with a title, description and due date.
Create connectorDraw a line between two items already on the board.
Create frameAdd a frame - a named, movable container other items can sit inside.
Create shapeAdd a shape to a board - a rectangle, circle, arrow and 18 others.
Create sticky noteAdd a sticky note to a board.
Create tagCreate a tag on a board, so it can be attached to cards and sticky notes.
Create textAdd a free-floating text item to a board.
Delete boardDelete a board permanently, along with every item on it.
Delete connectorDelete a connector.
Delete itemDelete any item from a board, regardless of its type.
Get boardRead one board in full: its name, share link, sharing settings, owner, team, and the connected user's own role on it.
Get connection infoRead what the connected access token can see: the organization, team and user it belongs to, and the scopes it was granted.
Get itemRead one item's position, size, parent frame and its own type-specific content.
List boardsList the boards the connected app's team membership can see.
List itemsList the items on a board - sticky notes, shapes, text, cards, frames and more - or narrow to one type.
Update boardRename a board or change who can open it from its share link.
Update cardChange a card's title, description, due date, size or position.
Update sticky noteChange a sticky note's text, colour, alignment, size or position.

Attach tag to item

Attach an existing tag to a card or sticky note. Only those two item types accept tags, and each can carry up to 8.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Item IDitem_idtextRequired
The item to act on, from 'List items' or an earlier step that created it.
Tag IDtag_idtextRequired
The tag to attach, from 'Create tag'.

Outputs

attachedtrue/false
board_idtext
item_idtext
tag_idtext
Example output
{
  "attached": true,
  "board_id": "uXjVI4TU3wc=",
  "item_id": "3458764600000000001",
  "tag_id": "3458764600000000007"
}

Create board

Create a new Miro board. Leave the team empty to create it in the token owner's own team. A Developer team is capped at 3 boards - Miro refuses a fourth.

Inputs

Board namenametext
Up to 60 characters. Leave empty for 'Untitled'.
Teammiro_team_idtext
The team to create it in. Leave empty for your own team.
Who can open the share linkaccesstext
Who can open this board from its share link, without being invited.One of: private (Private - only people explicitly invited), view (Anyone with the link can view), comment (Anyone with the link can comment), edit (Anyone with the link can edit). Default: private.

Outputs

createdAttext
createdByobject
currentUserMembershipobject
idtext
modifiedAttext
modifiedByobject
nametext
ownerobject
projectobject
teamobject
typetext
viewLinktext
Example output
{
  "createdAt": "2026-01-14T09:12:44Z",
  "createdBy": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  },
  "currentUserMembership": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "role": "owner",
    "type": "board_member"
  },
  "id": "uXjVI4TU3wc=",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "modifiedBy": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  },
  "name": "Lodol demo board",
  "owner": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  },
  "team": {
    "id": "3074457345000000001",
    "name": "Lodol demo team"
  },
  "type": "board",
  "viewLink": "https://miro.com/app/board/uXjVI4TU3wc=/"
}

Create card

Add a card - a task-shaped item with a title, description and due date.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
TitletitletextRequired
A short header for the card.
Descriptiondescriptiontext
A short description to add context.
Due datedue_datedate and time
When this card is due.
X positionxnumber
Horizontal position on the board. The board's centre is 0.
Y positionynumber
Vertical position on the board. The board's centre is 0.
Widthwidthnumber
Width in pixels. Leave empty for Miro's default size.At least 1.
Heightheightnumber
Height in pixels. Leave empty for Miro's default size.At least 1.
Parent frame IDparent_idtext
A frame to place this item inside. Leave empty to place it directly on the board.

Outputs

createdAttext
dataobject
geometryobject
idtext
modifiedAttext
parentobject
positionobject
styleobject
typetext
Example output
{
  "createdAt": "2026-02-02T16:40:11Z",
  "data": {
    "description": "Cut the release and notify the team",
    "dueDate": "2026-03-14T09:00:00Z",
    "title": "Ship it"
  },
  "geometry": {
    "height": 120.0,
    "width": 320.0
  },
  "id": "3458764600000000004",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "position": {
    "origin": "center",
    "x": 0.0,
    "y": 200.0
  },
  "style": {
    "cardTheme": "#2d9bf0"
  },
  "type": "card"
}

Create connector

Draw a line between two items already on the board.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Start item IDstart_item_idtextRequired
The item the connector starts at.
End item IDend_item_idtextRequired
The item the connector ends at.
Shapeshapetext
The connector's line shape. Defaults to curved.One of: straight, elbowed, curved. Default: curved.
Captioncaptiontext
A short label shown on the line.
Line colourstroke_colortext
A hex colour for the line, such as #1a1a1a.
Line stylestroke_styletext
Solid, dotted or dashed. Defaults to solid.One of: normal (Solid), dotted, dashed.

Outputs

captionslist
createdAttext
endItemobject
idtext
modifiedAttext
shapetext
startItemobject
styleobject
typetext
Example output
{
  "captions": [
    {
      "content": "leads to"
    }
  ],
  "createdAt": "2026-02-02T16:40:11Z",
  "endItem": {
    "id": "3458764600000000004"
  },
  "id": "3458764600000000006",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "shape": "curved",
  "startItem": {
    "id": "3458764600000000001"
  },
  "style": {
    "strokeColor": "#1a1a1a",
    "strokeStyle": "normal"
  },
  "type": "connector"
}

Create frame

Add a frame - a named, movable container other items can sit inside.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
TitletitletextRequired
The frame's title, shown at its top edge.
Background colourfill_colortext
A hex colour for the frame's background, such as #f5f6f8.
X positionxnumber
Horizontal position on the board. The board's centre is 0.
Y positionynumber
Vertical position on the board. The board's centre is 0.
Widthwidthnumber
Width in pixels. Leave empty for Miro's default size.At least 1.
Heightheightnumber
Height in pixels. Leave empty for Miro's default size.At least 1.

Outputs

createdAttext
dataobject
geometryobject
idtext
modifiedAttext
positionobject
styleobject
typetext
Example output
{
  "createdAt": "2026-02-02T16:40:11Z",
  "data": {
    "format": "custom",
    "title": "Sprint 12",
    "type": "freeform"
  },
  "geometry": {
    "height": 700.0,
    "width": 1000.0
  },
  "id": "3458764600000000005",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "position": {
    "origin": "center",
    "x": 0.0,
    "y": 0.0
  },
  "style": {
    "fillColor": "#ffffffff"
  },
  "type": "frame"
}

Create shape

Add a shape to a board - a rectangle, circle, arrow and 18 others. Fill and border colours are hex values such as #1a1a1a, since Miro does not restrict a shape's colours to a fixed set.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Contentcontenttext
Text to display on the shape.
Shapeshapetext
The shape's outline. Defaults to rectangle.One of: rectangle, round_rectangle (Rounded rectangle), circle, triangle, rhombus, parallelogram, trapezoid, pentagon, hexagon, octagon, and 11 more. Default: rectangle.
Fill colourfill_colortext
A hex colour for the shape's fill, such as #f5f6f8.
Border colourborder_colortext
A hex colour for the shape's outline, such as #1a1a1a.
Text alignmenttext_aligntext
Horizontal alignment of the text.One of: left, center, right.
X positionxnumber
Horizontal position on the board. The board's centre is 0.
Y positionynumber
Vertical position on the board. The board's centre is 0.
Widthwidthnumber
Width in pixels. Leave empty for Miro's default size.At least 1.
Heightheightnumber
Height in pixels. Leave empty for Miro's default size.At least 1.
Parent frame IDparent_idtext
A frame to place this item inside. Leave empty to place it directly on the board.

Outputs

createdAttext
dataobject
geometryobject
idtext
modifiedAttext
parentobject
positionobject
styleobject
typetext
Example output
{
  "createdAt": "2026-02-02T16:40:11Z",
  "data": {
    "content": "Q3 goals",
    "shape": "round_rectangle"
  },
  "geometry": {
    "height": 150.0,
    "width": 300.0
  },
  "id": "3458764600000000002",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "position": {
    "origin": "center",
    "x": 200.0,
    "y": 0.0
  },
  "style": {
    "borderColor": "#1a1a1a",
    "fillColor": "#f5f6f8",
    "textAlign": "center"
  },
  "type": "shape"
}

Create sticky note

Add a sticky note to a board.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Contentcontenttext
The note's text.
Shapeshapetext
The sticky note's outline. Defaults to square.One of: square, rectangle. Default: square.
Colourfill_colortext
The sticky note's background colour. Defaults to light yellow.One of: gray, light_yellow (Light yellow), yellow, orange, light_green (Light green), green, dark_green (Dark green), cyan, light_pink (Light pink), pink, and 6 more.
Text alignmenttext_aligntext
Horizontal alignment of the text.One of: left, center, right.
Vertical text alignmenttext_align_verticaltext
Vertical alignment of the text.One of: top, middle, bottom.
X positionxnumber
Horizontal position on the board. The board's centre is 0.
Y positionynumber
Vertical position on the board. The board's centre is 0.
Widthwidthnumber
Width in pixels. Leave empty for Miro's default size.At least 1.
Parent frame IDparent_idtext
A frame to place this item inside. Leave empty to place it directly on the board.

Outputs

createdAttext
dataobject
geometryobject
idtext
modifiedAttext
parentobject
positionobject
styleobject
typetext
Example output
{
  "createdAt": "2026-02-02T16:40:11Z",
  "data": {
    "content": "Ship it",
    "shape": "square"
  },
  "geometry": {
    "height": 199.0,
    "width": 199.0
  },
  "id": "3458764600000000001",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "position": {
    "origin": "center",
    "x": 0.0,
    "y": 0.0
  },
  "style": {
    "fillColor": "light_yellow",
    "textAlign": "center",
    "textAlignVertical": "top"
  },
  "type": "sticky_note"
}

Create tag

Create a tag on a board, so it can be attached to cards and sticky notes.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
TitletitletextRequired
The tag's text, up to 120 characters. Must be unique on the board.
Colourfill_colortext
The tag's colour. Defaults to red.One of: red, light_green (Light green), cyan, yellow, magenta, green, blue, gray, violet, dark_green (Dark green), dark_blue (Dark blue), black. Default: red.

Outputs

fillColortext
idtext
titletext
typetext
Example output
{
  "fillColor": "red",
  "id": "3458764600000000007",
  "title": "Blocked",
  "type": "tag"
}

Create text

Add a free-floating text item to a board. Only its width can be set - Miro grows the height to fit the text.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
ContentcontenttextRequired
The text to display.
Text colourcolortext
A hex colour for the text, such as #1a1a1a.
Background colourfill_colortext
A hex colour behind the text, such as #ffffff.
Font sizefont_sizenumber
Font size in points. Defaults to 14.At least 1.
Text alignmenttext_aligntext
Horizontal alignment of the text.One of: left, center, right.
X positionxnumber
Horizontal position on the board. The board's centre is 0.
Y positionynumber
Vertical position on the board. The board's centre is 0.
Widthwidthnumber
Width in pixels. Leave empty for Miro's default size.At least 1.
Parent frame IDparent_idtext
A frame to place this item inside. Leave empty to place it directly on the board.

Outputs

createdAttext
dataobject
geometryobject
idtext
modifiedAttext
parentobject
positionobject
styleobject
typetext
Example output
{
  "createdAt": "2026-02-02T16:40:11Z",
  "data": {
    "content": "Hello from Lodol"
  },
  "geometry": {
    "height": 30.0,
    "width": 200.0
  },
  "id": "3458764600000000003",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "position": {
    "origin": "center",
    "x": -200.0,
    "y": 0.0
  },
  "style": {
    "color": "#1a1a1a",
    "fillColor": "#ffffff",
    "fontSize": "14",
    "textAlign": "center"
  },
  "type": "text"
}

Delete board

Delete a board permanently, along with every item on it. On a paid plan this goes to Trash and can be restored within 90 days; on a Developer team it cannot be undone.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/

Outputs

board_idtext
deletedtrue/false
idtext
resourcetext
Example output
{
  "deleted": true,
  "id": "uXjVI4TU3wc=",
  "resource": "board"
}

Delete connector

Delete a connector. Not the same as 'Delete item' - a connector is a separate kind of record in Miro, and 'Delete item' cannot see it.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Connector IDconnector_idtextRequired
The connector to delete, from 'Create connector'.

Outputs

board_idtext
deletedtrue/false
idtext
resourcetext
Example output
{
  "board_id": "uXjVI4TU3wc=",
  "deleted": true,
  "id": "3458764600000000006",
  "resource": "connector"
}

Delete item

Delete any item from a board, regardless of its type.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Item IDitem_idtextRequired
The item to act on, from 'List items' or an earlier step that created it.

Outputs

board_idtext
deletedtrue/false
idtext
resourcetext
Example output
{
  "board_id": "uXjVI4TU3wc=",
  "deleted": true,
  "id": "3458764600000000001",
  "resource": "item"
}

Get board

Read one board in full: its name, share link, sharing settings, owner, team, and the connected user's own role on it.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/

Outputs

createdAttext
createdByobject
currentUserMembershipobject
idtext
modifiedAttext
modifiedByobject
nametext
ownerobject
projectobject
teamobject
typetext
viewLinktext
Example output
{
  "createdAt": "2026-01-14T09:12:44Z",
  "createdBy": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  },
  "currentUserMembership": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "role": "owner",
    "type": "board_member"
  },
  "id": "uXjVI4TU3wc=",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "modifiedBy": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  },
  "name": "Lodol demo board",
  "owner": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  },
  "team": {
    "id": "3074457345000000001",
    "name": "Lodol demo team"
  },
  "type": "board",
  "viewLink": "https://miro.com/app/board/uXjVI4TU3wc=/"
}

Get connection info

Read what the connected access token can see: the organization, team and user it belongs to, and the scopes it was granted. A quick way to confirm a connection is actually working, and works on every plan - unlike sharing a board by email, which a Free or Developer team cannot do at all.

Inputs

None.

Outputs

createdByobject
organizationobject
scopeslist
teamobject
typetext
userobject
Example output
{
  "createdBy": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  },
  "organization": {
    "id": "3074457345000000003",
    "name": "Lodol demo org",
    "type": "organization"
  },
  "scopes": [
    "boards:read",
    "boards:write"
  ],
  "team": {
    "id": "3074457345000000001",
    "name": "Lodol demo team",
    "type": "team"
  },
  "type": "token",
  "user": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  }
}

Get item

Read one item's position, size, parent frame and its own type-specific content.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Item IDitem_idtextRequired
The item to act on, from 'List items' or an earlier step that created it.

Outputs

createdAttext
createdByobject
dataobject
geometryobject
idtext
modifiedAttext
modifiedByobject
parentobject
positionobject
typetext
Example output
{
  "createdAt": "2026-02-02T16:40:11Z",
  "createdBy": {
    "id": "3074457345000000000",
    "type": "user"
  },
  "data": {
    "content": "Ship it",
    "shape": "square"
  },
  "geometry": {
    "height": 199.0,
    "width": 199.0
  },
  "id": "3458764600000000001",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "modifiedBy": {
    "id": "3074457345000000000",
    "type": "user"
  },
  "position": {
    "origin": "center",
    "x": 0.0,
    "y": 0.0
  },
  "type": "sticky_note"
}

List boards

List the boards the connected app's team membership can see. Returns each board's name, id, share link, owner and team. Narrow by a name or description search, by team, or by owner.

Inputs

Teammiro_team_idtext
Only boards belonging to this team. Leave empty for every team the token can see.
Queryquerytext
Only boards whose name or description contains this text.
Owner IDowner_idtext
Only boards owned by this user id.
Results per pagelimitnumber
How many to return, 1-50. Defaults to 20.From 1 to 50. Default: 20.
Offsetoffsetnumber
How many records to skip before the first one returned. Defaults to 0.At least 0. Default: 0.
Sortsorttext
How to order the results. Defaults to Miro's own default order.One of: default (Default order), last_modified (Last modified), last_opened (Last opened), last_created (Last created), alphabetically. Default: default.

Outputs

The boards this token can see

countnumber
Records on this page
has_moretrue/false
Whether more records exist
itemslist
limitnumber
The page size used
offsetnumber
The offset that was read
totalnumber
Total records available
Example output
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "createdAt": "2026-01-14T09:12:44Z",
      "createdBy": {
        "id": "3074457345000000000",
        "name": "Ada Lovelace",
        "type": "user"
      },
      "currentUserMembership": {
        "id": "3074457345000000000",
        "name": "Ada Lovelace",
        "role": "owner",
        "type": "board_member"
      },
      "id": "uXjVI4TU3wc=",
      "modifiedAt": "2026-02-02T16:41:08Z",
      "modifiedBy": {
        "id": "3074457345000000000",
        "name": "Ada Lovelace",
        "type": "user"
      },
      "name": "Lodol demo board",
      "owner": {
        "id": "3074457345000000000",
        "name": "Ada Lovelace",
        "type": "user"
      },
      "team": {
        "id": "3074457345000000001",
        "name": "Lodol demo team"
      },
      "type": "board",
      "viewLink": "https://miro.com/app/board/uXjVI4TU3wc=/"
    }
  ],
  "limit": 20,
  "offset": 0,
  "total": 1
}

List items

List the items on a board - sticky notes, shapes, text, cards, frames and more - or narrow to one type. Each item reports its id, type, position, size and its own content.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Item typeitem_typetext
Only items of this type. Leave empty for every type.One of: text, shape, sticky_note (Sticky note), image, document, card, app_card (App card), preview, frame, embed.
Results per pagelimitnumber
How many to return, 1-50. Defaults to 10.From 1 to 50. Default: 10.
Cursorcursortext
Pass the 'next_cursor' from a previous call to read the next page.

Outputs

The board's items

countnumber
Records on this page
has_moretrue/false
Whether another page exists
itemslist
limitnumber
The page size used
next_cursortext
Pass this as 'cursor' to read the next page
totalnumber
Total records available
Example output
{
  "count": 1,
  "has_more": false,
  "items": [
    {
      "createdAt": "2026-02-02T16:40:11Z",
      "createdBy": {
        "id": "3074457345000000000",
        "type": "user"
      },
      "data": {
        "content": "Ship it",
        "shape": "square"
      },
      "geometry": {
        "height": 199.0,
        "width": 199.0
      },
      "id": "3458764600000000001",
      "modifiedAt": "2026-02-02T16:41:08Z",
      "modifiedBy": {
        "id": "3074457345000000000",
        "type": "user"
      },
      "position": {
        "origin": "center",
        "x": 0.0,
        "y": 0.0
      },
      "type": "sticky_note"
    }
  ],
  "limit": 10,
  "next_cursor": null,
  "total": 1
}

Update board

Rename a board or change who can open it from its share link. Only the fields you fill in are sent.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Board namenametext
A new name, up to 60 characters.
Who can open the share linkaccesstext
Who can open this board from its share link, without being invited.One of: private (Private - only people explicitly invited), view (Anyone with the link can view), comment (Anyone with the link can comment), edit (Anyone with the link can edit).

Outputs

createdAttext
createdByobject
currentUserMembershipobject
idtext
modifiedAttext
modifiedByobject
nametext
ownerobject
projectobject
teamobject
typetext
viewLinktext
Example output
{
  "createdAt": "2026-01-14T09:12:44Z",
  "createdBy": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  },
  "currentUserMembership": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "role": "owner",
    "type": "board_member"
  },
  "id": "uXjVI4TU3wc=",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "modifiedBy": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  },
  "name": "Lodol demo board",
  "owner": {
    "id": "3074457345000000000",
    "name": "Ada Lovelace",
    "type": "user"
  },
  "team": {
    "id": "3074457345000000001",
    "name": "Lodol demo team"
  },
  "type": "board",
  "viewLink": "https://miro.com/app/board/uXjVI4TU3wc=/"
}

Update card

Change a card's title, description, due date, size or position.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Item IDitem_idtextRequired
The item to act on, from 'List items' or an earlier step that created it.
Titletitletext
A new header for the card.
Descriptiondescriptiontext
A new description for the card.
Due datedue_datedate and time
A new due date for the card.
X positionxnumber
Horizontal position on the board. The board's centre is 0.
Y positionynumber
Vertical position on the board. The board's centre is 0.
Widthwidthnumber
Width in pixels. Leave empty for Miro's default size.At least 1.
Heightheightnumber
Height in pixels. Leave empty for Miro's default size.At least 1.
Parent frame IDparent_idtext
A frame to place this item inside. Leave empty to place it directly on the board.

Outputs

createdAttext
dataobject
geometryobject
idtext
modifiedAttext
parentobject
positionobject
styleobject
typetext
Example output
{
  "createdAt": "2026-02-02T16:40:11Z",
  "data": {
    "description": "Cut the release and notify the team",
    "dueDate": "2026-03-14T09:00:00Z",
    "title": "Ship it"
  },
  "geometry": {
    "height": 120.0,
    "width": 320.0
  },
  "id": "3458764600000000004",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "position": {
    "origin": "center",
    "x": 0.0,
    "y": 200.0
  },
  "style": {
    "cardTheme": "#2d9bf0"
  },
  "type": "card"
}

Update sticky note

Change a sticky note's text, colour, alignment, size or position.

Inputs

Boardboard_idtextRequired
The board to act on. Paste its id, or the board's URL such as https://miro.com/app/board/uXjVI4TU3wc=/
Item IDitem_idtextRequired
The item to act on, from 'List items' or an earlier step that created it.
Contentcontenttext
New text for the note.
Shapeshapetext
A new outline for the note.One of: square, rectangle.
Colourfill_colortext
A new background colour for the note.One of: gray, light_yellow (Light yellow), yellow, orange, light_green (Light green), green, dark_green (Dark green), cyan, light_pink (Light pink), pink, and 6 more.
Text alignmenttext_aligntext
Horizontal alignment of the text.One of: left, center, right.
Vertical text alignmenttext_align_verticaltext
A new vertical alignment for the text.One of: top, middle, bottom.
X positionxnumber
Horizontal position on the board. The board's centre is 0.
Y positionynumber
Vertical position on the board. The board's centre is 0.
Widthwidthnumber
Width in pixels. Leave empty for Miro's default size.At least 1.
Parent frame IDparent_idtext
A frame to place this item inside. Leave empty to place it directly on the board.

Outputs

createdAttext
dataobject
geometryobject
idtext
modifiedAttext
parentobject
positionobject
styleobject
typetext
Example output
{
  "createdAt": "2026-02-02T16:40:11Z",
  "data": {
    "content": "Ship it",
    "shape": "square"
  },
  "geometry": {
    "height": 199.0,
    "width": 199.0
  },
  "id": "3458764600000000001",
  "modifiedAt": "2026-02-02T16:41:08Z",
  "position": {
    "origin": "center",
    "x": 0.0,
    "y": 0.0
  },
  "style": {
    "fillColor": "light_yellow",
    "textAlign": "center",
    "textAlignVertical": "top"
  },
  "type": "sticky_note"
}

On this page