---
updatedAt: 2026-04-21T11:23:22.000Z
---
Fetch the complete documentation index at: https://developers.miro.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.
# Create sticky note item
Adds a sticky note item to a board.
Required scope
boards:write
Rate limiting
Level 2
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Platform",
"version": "v2.0"
},
"x-settings": {
"publish": true
},
"servers": [
{
"url": "https://api.miro.com"
}
],
"security": [
{
"bearerAuth": []
}
],
"tags": [
{
"name": "Sticky note items"
}
],
"paths": {
"/v2/boards/{board_id}/sticky_notes": {
"post": {
"description": "Adds a sticky note item to a board.
Required scope
boards:write
Rate limiting
Level 2
",
"operationId": "create-sticky-note-item",
"parameters": [
{
"description": "Unique identifier (ID) of the board where you want to create the item.",
"in": "path",
"name": "board_id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StickyNoteCreateRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StickyNoteItem"
}
}
},
"description": "Sticky Note item created"
},
"400": {
"$ref": "#/components/responses/400"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"summary": "Create sticky note item",
"tags": [
"Sticky note items"
]
}
}
},
"components": {
"schemas": {
"FixedRatioNoRotationGeometry": {
"type": "object",
"description": "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.",
"properties": {
"height": {
"type": "number",
"format": "double",
"description": "Height of the item, in pixels."
},
"width": {
"type": "number",
"format": "double",
"description": "Width of the item, in pixels."
}
}
},
"Geometry": {
"type": "object",
"description": "Contains geometrical information about the item, such as its width or height.",
"properties": {
"height": {
"type": "number",
"format": "double",
"description": "Height of the item, in pixels.",
"example": 60
},
"rotation": {
"type": "number",
"format": "double",
"description": "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": {
"type": "number",
"format": "double",
"description": "Width of the item, in pixels.",
"example": 320
}
}
},
"Parent": {
"type": "object",
"description": "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.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier (ID) of the parent frame for the item."
}
}
},
"ParentLinksEnvelope": {
"type": "object",
"description": "Contains information about the parent frame for the item.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier (ID) of the parent frame for the item.",
"example": "3074457362577955300"
},
"links": {
"$ref": "#/components/schemas/SelfLink"
}
}
},
"Position": {
"type": "object",
"description": "Contains location information about the item, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.",
"properties": {
"origin": {
"type": "string",
"default": "center",
"description": "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.\nCurrently, only one option is supported (center).",
"enum": [
"center"
]
},
"relativeTo": {
"type": "string",
"enum": [
"canvas_center",
"parent_top_left"
]
},
"x": {
"type": "number",
"format": "double",
"description": "X-axis coordinate of the location of the item on the board.\nBy default, all items have absolute positioning to the board, not the current viewport. Default: 0.\nThe center point of the board has `x: 0` and `y: 0` coordinates.",
"example": 100
},
"y": {
"type": "number",
"format": "double",
"description": "Y-axis coordinate of the location of the item on the board.\nBy default, all items have absolute positioning to the board, not the current viewport. Default: 0.\nThe center point of the board has `x: 0` and `y: 0` coordinates.",
"example": 100
},
"slotId": {
"type": "string",
"description": "Unique identifier (ID) of the slot on the doc where the item is placed. This helps determine where in the doc a certain item has been placed. This is used only for Miro docs currently.",
"example": "123"
}
}
},
"PositionChange": {
"type": "object",
"description": "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.",
"properties": {
"x": {
"type": "number",
"format": "double",
"description": "X-axis coordinate of the location of the item on the board.\nBy default, all items have absolute positioning to the board, not the current viewport. Default: 0.\nThe center point of the board has `x: 0` and `y: 0` coordinates.",
"example": 100
},
"y": {
"type": "number",
"format": "double",
"description": "Y-axis coordinate of the location of the item on the board.\nBy default, all items have absolute positioning to the board, not the current viewport. Default: 0.\nThe center point of the board has `x: 0` and `y: 0` coordinates.",
"example": 100
}
}
},
"SelfLink": {
"type": "object",
"description": "Contains applicable links for the current object.",
"properties": {
"self": {
"type": "string",
"description": "Link to obtain more information about the current object.",
"example": "http://api.miro.com/v2/boards/o9J_koQspF4=/object_type/3074457349143649487"
}
}
},
"StickyNoteCreateRequest": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/StickyNoteData"
},
"style": {
"$ref": "#/components/schemas/StickyNoteStyle"
},
"position": {
"$ref": "#/components/schemas/PositionChange"
},
"geometry": {
"$ref": "#/components/schemas/FixedRatioNoRotationGeometry"
},
"parent": {
"$ref": "#/components/schemas/Parent"
}
}
},
"StickyNoteData": {
"type": "object",
"description": "Contains sticky note item data, such as the content or shape of the sticky note.",
"properties": {
"content": {
"type": "string",
"description": "The actual text (content) that appears in the sticky note item.",
"example": "Hello"
},
"shape": {
"type": "string",
"default": "square",
"description": "Defines the geometric shape of the sticky note and aspect ratio for its dimensions.",
"enum": [
"square",
"rectangle"
]
}
}
},
"StickyNoteItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier (ID) of an item.",
"example": "3458764517517819000"
},
"data": {
"$ref": "#/components/schemas/StickyNoteData"
},
"style": {
"$ref": "#/components/schemas/StickyNoteStyle"
},
"position": {
"$ref": "#/components/schemas/Position"
},
"geometry": {
"$ref": "#/components/schemas/Geometry"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when the item was created.
Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
"example": "2022-03-30 17:26:50+00:00"
},
"createdBy": {
"$ref": "#/components/schemas/createdBy"
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time when the item was last modified.
Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).",
"example": "2022-03-30 17:26:50+00:00"
},
"modifiedBy": {
"$ref": "#/components/schemas/modifiedBy"
},
"parent": {
"$ref": "#/components/schemas/ParentLinksEnvelope"
},
"links": {
"$ref": "#/components/schemas/WidgetLinks"
},
"type": {
"type": "string",
"description": "Type of item that is returned.",
"example": "sticky_note"
}
},
"required": [
"id",
"type"
]
},
"StickyNoteStyle": {
"type": "object",
"description": "Contains information about the style of a sticky note item, such as the fill color or text alignment.",
"properties": {
"fillColor": {
"type": "string",
"description": "Fill color for the sticky note.\nDefault: `light_yellow`.",
"enum": [
"gray",
"light_yellow",
"yellow",
"orange",
"light_green",
"green",
"dark_green",
"cyan",
"light_pink",
"pink",
"violet",
"red",
"light_blue",
"blue",
"dark_blue",
"black"
]
},
"textAlign": {
"type": "string",
"description": "Defines how the sticky note text is horizontally aligned.\nDefault: `center`.",
"enum": [
"left",
"right",
"center"
]
},
"textAlignVertical": {
"type": "string",
"description": "Defines how the sticky note text is vertically aligned.\nDefault: `top`.",
"enum": [
"top",
"middle",
"bottom"
]
}
}
},
"WidgetLinks": {
"type": "object",
"description": "Contains applicable links for the item.",
"properties": {
"related": {
"type": "string",
"description": "Link to obtain information about the child items related to the frame.",
"example": "http://api.miro.com/v2/boards/o9J_koQspF4=/items?parent_item_id=307445734914369434&limit=10&cursor="
},
"self": {
"type": "string",
"description": "Link to obtain information about the current item.",
"example": "http://api.miro.com/v2/boards/o9J_koQspF4=/item/3074457349143649487"
}
}
},
"createdBy": {
"type": "object",
"description": "Contains information about the user who created the item.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier (ID) of the user.",
"example": "3458764517517852417"
},
"type": {
"type": "string",
"description": "Indicates the type of object returned. In this case, `type` returns `user`.",
"example": "user"
}
}
},
"modifiedBy": {
"type": "object",
"description": "Contains information about the user who last modified the item.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier (ID) of the user.",
"example": "3458764517517852417"
},
"type": {
"type": "string",
"description": "Indicates the type of object returned. In this case, `type` returns `user`.",
"example": "user"
}
}
},
"BasicError": {
"type": "object",
"properties": {
"status": {
"type": "integer",
"description": "HTTP status code."
},
"code": {
"type": "string",
"description": "Description of the status code."
},
"message": {
"type": "string",
"description": "Explanation for the error"
},
"type": {
"type": "string",
"description": "Type of the object returned.",
"default": "error"
}
}
}
},
"responses": {
"400": {
"description": "Malformed request",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BasicError"
},
{
"type": "object",
"properties": {
"status": {
"default": 400
},
"code": {
"default": "invalidParameters"
}
}
}
]
}
}
}
},
"404": {
"description": "Invalid access",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BasicError"
},
{
"type": "object",
"properties": {
"status": {
"default": 404
},
"code": {
"default": "notFound"
}
}
}
]
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/BasicError"
},
{
"type": "object",
"properties": {
"status": {
"default": 429
},
"code": {
"default": "tooManyRequests"
}
}
}
]
}
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
```
# Sibling pages
* [Get sticky note item](https://developers.miro.com/miro-ea/reference/get-sticky-note-item-1.md)
* [Update sticky note item](https://developers.miro.com/miro-ea/reference/update-sticky-note-item-1.md)
* [Delete sticky note item](https://developers.miro.com/miro-ea/reference/delete-sticky-note-item-1.md)