Create sticky note item

post https://api.miro.com/v2/boards/{board_id}/sticky_notes

Adds a sticky note item to a board.

Required scope

boards:write

Rate limiting

Level 2

Path Params

board_id

string

required

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

Body Params

data

object

Contains sticky note item data, such as the content or shape of the sticky note.

style

object

Contains information about the style of a sticky note item, such as the fill color or text alignment.

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.

geometry

object

Contains geometrical information about the item. You can set either the width or height. You cannot set both the width and height at the same time.

parent

object

Contains information about the parent this item must be attached to. A maximum of 5000 items can be attached to a frame. Passing null for parent.id directly attaches an item to the canvas.

Responses

Response body

object

string

required

Unique identifier (ID) of an item.

data

object

Contains sticky note item data, such as the content or shape of the sticky note.

content

string

The actual text (content) that appears in the sticky note item.

shape

string

Defaults to square

Defines the geometric shape of the sticky note and aspect ratio for its dimensions.

square rectangle

style

object

Contains information about the style of a sticky note item, such as the fill color or text alignment.

fillColor

string

Fill color for the sticky note.
Default: light_yellow.

gray light_yellow yellow orange light_green green dark_green cyan light_pink pink violet red light_blue blue dark_blue black

textAlign

string

Defines how the sticky note text is horizontally aligned.
Default: center.

left right center

textAlignVertical

string

Defines how the sticky note text is vertically aligned.
Default: top.

top middle bottom

position

object

Contains location information about the item, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.

origin

string

Defaults to center

Area of the item that is referenced by its x and y coordinates. For example, an item with a center origin will have its x and y coordinates point to its center. The center point of the board has x: 0 and y: 0 coordinates.
Currently, only one option is supported (center).

center

relativeTo

string

canvas_center parent_top_left

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.

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.

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.

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.

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.

string

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

links

object

Contains applicable links for the current object.

links

object

Contains applicable links for the item.

string

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

self

string

Link to obtain information about the current item.

type

string

required

Type of item that is returned.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.miro.com/v2/boards/board_id/sticky_notes \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Sticky Note item created

400Malformed request

404Invalid access

429Too many requests