> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # miro-items > Miro Items - create and manage content: sticky notes, cards, shapes, texts, images, documents **Server path:** `/miro-items` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | | [`miro_items_create_app_card_item`](#miro_items_create_app_card_item) | Create app card item | | [`miro_items_create_card_item`](#miro_items_create_card_item) | Create card item | | [`miro_items_create_code_widget_item`](#miro_items_create_code_widget_item) | Create code widget item | | [`miro_items_create_doc_format_item`](#miro_items_create_doc_format_item) | Create doc format item | | [`miro_items_create_document_item_using_file_from_device`](#miro_items_create_document_item_using_file_from_device) | Create document item using file from device | | [`miro_items_create_document_item_using_url`](#miro_items_create_document_item_using_url) | Create document item using URL | | [`miro_items_create_embed_item`](#miro_items_create_embed_item) | Create embed item | | [`miro_items_create_image_item_using_local_file`](#miro_items_create_image_item_using_local_file) | Create image item using file from device | | [`miro_items_create_image_item_using_url`](#miro_items_create_image_item_using_url) | Create image item using URL | | [`miro_items_create_shape_item`](#miro_items_create_shape_item) | Create shape item | | [`miro_items_create_sticky_note_item`](#miro_items_create_sticky_note_item) | Create sticky note item | | [`miro_items_create_text_item`](#miro_items_create_text_item) | Create text item | | [`miro_items_delete_app_card_item`](#miro_items_delete_app_card_item) | Delete app card item | | [`miro_items_delete_card_item`](#miro_items_delete_card_item) | Delete card item | | [`miro_items_delete_code_widget_item`](#miro_items_delete_code_widget_item) | Delete code widget item | | [`miro_items_delete_doc_format_item`](#miro_items_delete_doc_format_item) | Delete doc format item | | [`miro_items_delete_document_item`](#miro_items_delete_document_item) | Delete document item | | [`miro_items_delete_embed_item`](#miro_items_delete_embed_item) | Delete embed item | | [`miro_items_delete_image_item`](#miro_items_delete_image_item) | Delete image item | | [`miro_items_delete_shape_item`](#miro_items_delete_shape_item) | Delete shape item | | [`miro_items_delete_sticky_note_item`](#miro_items_delete_sticky_note_item) | Delete sticky note item | | [`miro_items_delete_text_item`](#miro_items_delete_text_item) | Delete text item | | [`miro_items_get_app_card_item`](#miro_items_get_app_card_item) | Get app card item | | [`miro_items_get_card_item`](#miro_items_get_card_item) | Get card item | | [`miro_items_get_code_widget_item`](#miro_items_get_code_widget_item) | Get code widget item | | [`miro_items_get_code_widget_items`](#miro_items_get_code_widget_items) | Get code widget items | | [`miro_items_get_doc_format_item`](#miro_items_get_doc_format_item) | Get doc format item | | [`miro_items_get_document_item`](#miro_items_get_document_item) | Get document item | | [`miro_items_get_embed_item`](#miro_items_get_embed_item) | Get embed item | | [`miro_items_get_image_item`](#miro_items_get_image_item) | Get image item | | [`miro_items_get_shape_item`](#miro_items_get_shape_item) | Get shape item | | [`miro_items_get_sticky_note_item`](#miro_items_get_sticky_note_item) | Get sticky note item | | [`miro_items_get_text_item`](#miro_items_get_text_item) | Get text item | | [`miro_items_move_code_widget_item`](#miro_items_move_code_widget_item) | Move code widget item | | [`miro_items_update_app_card_item`](#miro_items_update_app_card_item) | Update app card item | | [`miro_items_update_card_item`](#miro_items_update_card_item) | Update card item | | [`miro_items_update_code_widget_item`](#miro_items_update_code_widget_item) | Update code widget item | | [`miro_items_update_document_item_using_file_from_device`](#miro_items_update_document_item_using_file_from_device) | Update document item using file from device | | [`miro_items_update_document_item_using_url`](#miro_items_update_document_item_using_url) | Update document item using URL | | [`miro_items_update_embed_item`](#miro_items_update_embed_item) | Update embed item | | [`miro_items_update_image_item_using_file_from_device`](#miro_items_update_image_item_using_file_from_device) | Update image item using file from device | | [`miro_items_update_image_item_using_url`](#miro_items_update_image_item_using_url) | Update image item using URL | | [`miro_items_update_shape_item`](#miro_items_update_shape_item) | Update shape item | | [`miro_items_update_sticky_note_item`](#miro_items_update_sticky_note_item) | Update sticky note item | | [`miro_items_update_text_item`](#miro_items_update_text_item) | Update text item | *** ## miro\_items\_create\_app\_card\_item Create app card item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | No | — | Contains app card item data, such as the title, description, or fields. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or height. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | | `style` | object | No | — | Contains information about the style of an app card item, such as the fill color. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "Contains app card item data, such as the title, description, or fields.", "properties": { "description": { "type": "string", "description": "A short text description to add context about the app card." }, "fields": { "type": "array", "items": { "type": "object" }, "description": "Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view." }, "status": { "type": "string", "description": "Status indicating whether an app card is connected and in sync with the source. When the source for the app card is deleted, the status returns `disabled`.", "enum": [ "disconnected", "connected", "disabled" ] }, "title": { "type": "string", "description": "A short text header to identify the app card." } } }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or height.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "rotation": { "type": "number", "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", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } }, "style": { "type": "object", "description": "Contains information about the style of an app card item, such as the fill color.", "properties": { "fillColor": { "type": "string", "description": "Hex value of the border color of the app card. Default: `#2d9bf0`." } } } }, "required": [ "PCID", "board_id" ] } ``` *** ## miro\_items\_create\_card\_item Create card item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | No | — | Contains card item data, such as the title, description, due date, or assignee ID. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or height. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | | `style` | object | No | — | Contains information about the style of a card item, such as the card theme. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "Contains card item data, such as the title, description, due date, or assignee ID.", "properties": { "assigneeId": { "type": "string", "description": "Unique user identifier. In the GUI, the user ID is mapped to the name of the user who is assigned as the owner of the task or activity described in the card. The identifier is numeric, and it is automatically assigned to a user when they first sign up." }, "description": { "type": "string", "description": "A short text description to add context about the card." }, "dueDate": { "type": "string", "description": "The date when the task or activity described in the card is due to be completed. In the GUI, users can select the due date from a calendar. 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))." }, "title": { "type": "string", "description": "A short text header for the card." } } }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or height.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "rotation": { "type": "number", "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", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } }, "style": { "type": "object", "description": "Contains information about the style of a card item, such as the card theme.", "properties": { "cardTheme": { "type": "string", "description": "Hex value of the border color of the card. Default: `#2d9bf0`." } } } }, "required": [ "PCID", "board_id" ] } ``` *** ## miro\_items\_create\_code\_widget\_item Create code widget item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | No | — | Contains the data properties of a code widget item, such as the code content, programming language, and display settings. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or height. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "Contains the data properties of a code widget item, such as the code content, programming language, and display settings.", "properties": { "code": { "type": "string", "description": "The code content of the widget." }, "language": { "type": "string", "description": "The programming language of the code content. Used for syntax highlighting." }, "lineNumbersVisible": { "type": "boolean", "description": "Indicates whether line numbers are visible in the code widget." }, "title": { "type": "string", "description": "The title of the code widget." } } }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or height.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "rotation": { "type": "number", "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", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } } }, "required": [ "PCID", "board_id" ] } ``` *** ## miro\_items\_create\_doc\_format\_item Create doc format item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | Yes | — | The data value | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "The data value", "properties": { "contentType": { "type": "string", "description": "Content Type", "enum": [ "markdown" ] }, "content": { "type": "string", "description": "a string of markdown text" }, "contentVersion": { "type": "number", "description": "Content Version" } }, "required": [ "contentType", "content" ] }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } } }, "required": [ "PCID", "board_id", "data" ] } ``` *** ## miro\_items\_create\_document\_item\_using\_file\_from\_device Create document item using file from device **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `board_id_PlatformFileUpload` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | No | — | The data value | | `resource` | string | Yes | — | Select a file to upload. Maximum file size is 6 MB. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id_PlatformFileUpload": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "Title for the document." }, "position": { "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." }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time." }, "parent": { "type": "object", "description": "Contains information about the parent frame for the item." } } }, "resource": { "type": "string", "description": "Select a file to upload. Maximum file size is 6 MB." } }, "required": [ "PCID", "board_id_PlatformFileUpload", "resource" ] } ``` *** ## miro\_items\_create\_document\_item\_using\_url Create document item using URL **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | Yes | — | Contains information about the document URL. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "Contains information about the document URL.", "properties": { "title": { "type": "string", "description": "A short text header to identify the document." }, "url": { "type": "string", "description": "URL where the document is hosted." } }, "required": [ "url" ] }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } } }, "required": [ "PCID", "board_id", "data" ] } ``` *** ## miro\_items\_create\_embed\_item Create embed item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | Yes | — | Contains information about the embed URL. | | `geometry` | object | No | — | 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 | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "Contains information about the embed URL.", "properties": { "mode": { "type": "string", "description": "Defines how the content in the embed item is displayed on the board. `inline`: The embedded content is displayed directly on the board. `modal`: The embedded content is displayed inside a modal overlay on the board.", "enum": [ "inline", "modal" ] }, "previewUrl": { "type": "string", "description": "URL of the image to be used as the preview image for the embedded item." }, "url": { "type": "string", "description": "A [valid URL](https://developers.miro.com/reference/data#embeddata) pointing to the content resource that you want to embed in the board. Possible transport protocols: HTTP, HTTPS." } }, "required": [ "url" ] }, "geometry": { "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", "description": "Height of the item, in pixels." }, "width": { "type": "number", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } } }, "required": [ "PCID", "board_id", "data" ] } ``` *** ## miro\_items\_create\_image\_item\_using\_local\_file Create image item using file from device **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `board_id_PlatformFileUpload` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | No | — | The data value | | `resource` | string | Yes | — | Select a file to upload. Maximum file size is 6 MB. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id_PlatformFileUpload": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "Title for the document." }, "altText": { "type": "string", "description": "A description (alt-text) to help people understand what is depicted here." }, "position": { "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." }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time." }, "parent": { "type": "object", "description": "Contains information about the parent frame for the item." } } }, "resource": { "type": "string", "description": "Select a file to upload. Maximum file size is 6 MB." } }, "required": [ "PCID", "board_id_PlatformFileUpload", "resource" ] } ``` *** ## miro\_items\_create\_image\_item\_using\_url Create image item using URL **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | Yes | — | Contains information about the image URL. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "Contains information about the image URL.", "properties": { "title": { "type": "string", "description": "A short text header to identify the image." }, "url": { "type": "string", "description": "URL of the image." } }, "required": [ "url" ] }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "width": { "type": "number", "description": "Width of the item, in pixels." }, "rotation": { "type": "number", "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." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } } }, "required": [ "PCID", "board_id", "data" ] } ``` *** ## miro\_items\_create\_shape\_item Create shape item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | No | — | Contains shape item data, such as the content or the type of the shape. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or height. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | | `style` | object | No | — | Contains information about the shape style, such as the border color or opacity. \
All properties in style object are supported for shape types aren't listed below. \
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \
Shape type\Unsupported properties\
flow\_chart\_or\fontSize, fontFamily, color, textAlign, textAlignVertical\
flow\_chart\_summing\_junction\fontSize, fontFamily, color, textAlign, textAlignVertical\
flow\_chart\_note\_curly\_left\fillColor, fillOpacity\
flow\_chart\_note\_curly\_right\fillColor, fillOpacity\
flow\_chart\_note\_square\fillColor, fillOpacity\
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "Contains shape item data, such as the content or the type of the shape.", "properties": { "content": { "type": "string", "description": "The text you want to display on the shape.
**Not supported for shapes:** " }, "shape": { "type": "string", "description": "Defines the geometric shape of the item when it is rendered on the board.
Basic shapes
Flowchart shapes
" } } }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or height.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "rotation": { "type": "number", "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", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } }, "style": { "type": "object", "description": "Contains information about the shape style, such as the border color or opacity.
All properties in style object are supported for shape types aren't listed below.
Shape type Unsupported properties
flow_chart_or fontSize, fontFamily, color, textAlign, textAlignVertical
flow_chart_summing_junction fontSize, fontFamily, color, textAlign, textAlignVertical
flow_chart_note_curly_left fillColor, fillOpacity
flow_chart_note_curly_right fillColor, fillOpacity
flow_chart_note_square fillColor, fillOpacity
", "properties": { "borderColor": { "type": "string", "description": "Defines the color of the border of the shape. Default: `#1a1a1a` (dark gray)." }, "borderOpacity": { "type": "string", "description": "Defines the opacity level of the shape border. Possible values: any number between `0.0` and `1.0`, where: `0.0`: the background color is completely transparent or invisible `1.0`: the background color is completely opaque or solid Default: `1.0` (solid color)." }, "borderStyle": { "type": "string", "description": "Defines the style used to represent the border of the shape. Default: `normal`.", "enum": [ "normal", "dotted", "dashed" ] }, "borderWidth": { "type": "string", "description": "Defines the thickness of the shape border, in dp. Default: `2.0`." }, "color": { "type": "string", "description": "Hex value representing the color for the text within the shape item. Default: `#1a1a1a`." }, "fillColor": { "type": "string", "description": "Fill color for the shape. Hex values: `#f5f6f8` `#d5f692` `#d0e17a` `#93d275` `#67c6c0` `#23bfe7` `#a6ccf5` `#7b92ff` `#fff9b1` `#f5d128` `#ff9d48` `#f16c7f` `#ea94bb` `#ffcee0` `#b384bb` `#000000` Default: #ffffff." }, "fillOpacity": { "type": "string", "description": "Opacity level of the fill color. Possible values: any number between `0` and `1`, where: `0.0`: the background color is completely transparent or invisible `1.0`: the background color is completely opaque or solid Default: `Flowchart` shapes: `1.0`. `Basic` shapes: `1.0` if `fillColor` provided, `0.0` if no `fillColor` provided." }, "fontFamily": { "type": "string", "description": "Defines the font type for the text in the shape item. Default: `arial`.", "enum": [ "arial", "abril_fatface", "bangers", "eb_garamond", "georgia", "graduate", "gravitas_one", "fredoka_one", "nixie_one", "open_sans", "permanent_marker", "pt_sans", "pt_sans_narrow", "pt_serif", "rammetto_one", "roboto", "roboto_condensed", "roboto_slab", "caveat", "times_new_roman", "titan_one", "lemon_tuesday", "roboto_mono", "noto_sans", "plex_sans", "plex_serif", "plex_mono", "spoof", "tiempos_text", "formular" ] }, "fontSize": { "type": "string", "description": "Defines the font size, in dp, for the text on the shape. Default: `14`." }, "textAlign": { "type": "string", "description": "Defines how the shape text is horizontally aligned. Default: Flowchart shapes: `center`. Basic shapes: `left`. `unknown` is returned for unsupported shapes.", "enum": [ "left", "right", "center", "unknown" ] }, "textAlignVertical": { "type": "string", "description": "Defines how the shape text is vertically aligned. Default: Flowchart shapes: `middle`. Basic shapes: `top`. `unknown` is returned for unsupported shapes.", "enum": [ "top", "middle", "bottom", "unknown" ] } } } }, "required": [ "PCID", "board_id" ] } ``` *** ## miro\_items\_create\_sticky\_note\_item Create sticky note item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | No | — | Contains sticky note item data, such as the content or shape of the sticky note. | | `geometry` | object | No | — | 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 | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | | `style` | object | No | — | Contains information about the style of a sticky note item, such as the fill color or text alignment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "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." }, "shape": { "type": "string", "description": "Defines the geometric shape of the sticky note and aspect ratio for its dimensions.", "enum": [ "square", "rectangle" ] } } }, "geometry": { "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", "description": "Height of the item, in pixels." }, "width": { "type": "number", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } }, "style": { "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. Default: `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. Default: `center`.", "enum": [ "left", "right", "center" ] }, "textAlignVertical": { "type": "string", "description": "Defines how the sticky note text is vertically aligned. Default: `top`.", "enum": [ "top", "middle", "bottom" ] } } } }, "required": [ "PCID", "board_id" ] } ``` *** ## miro\_items\_create\_text\_item Create text item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to create the item. | | `data` | object | Yes | — | Contains text item data, such as the title, content, or description. For more information on the JSON properties, see [Data](https://developers.miro.com/reference/data). | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or rotation. You can only specify the width of the text item as the height is dynamically updated based on the content. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | | `style` | object | No | — | Contains information about the style of a text item, such as the fill color or font family. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to create the item." }, "data": { "type": "object", "description": "Contains text item data, such as the title, content, or description. For more information on the JSON properties, see [Data](https://developers.miro.com/reference/data).", "properties": { "content": { "type": "string", "description": "The actual text (content) that appears in the text item." } }, "required": [ "content" ] }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or rotation. You can only specify the width of the text item as the height is dynamically updated based on the content.", "properties": { "rotation": { "type": "number", "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", "description": "Width of the item, in pixels. The minimum `width` of a `text` widget is relative to the font size of the `text` widget. The width must be at least 1.7 times wider than the font size. For example, if the font size of the `text` item is `14`, the minimum `width` is `24`." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } }, "style": { "type": "object", "description": "Contains information about the style of a text item, such as the fill color or font family.", "properties": { "color": { "type": "string", "description": "Hex value representing the color for the text within the text item. Default: `#1a1a1a`." }, "fillColor": { "type": "string", "description": "Background color of the text item. Default: `#ffffff`." }, "fillOpacity": { "type": "string", "description": "Opacity level of the background color. Possible values: any number between `0.0` and `1.0`, where: `0.0`: the background color is completely transparent or invisible. `1.0`: the background color is completely opaque or solid. Default: `1.0` if `fillColor` is provided, `0.0` if `fillColor` is not provided." }, "fontFamily": { "type": "string", "description": "Font type for the text in the text item. Default: `arial`.", "enum": [ "arial", "abril_fatface", "bangers", "eb_garamond", "georgia", "graduate", "gravitas_one", "fredoka_one", "nixie_one", "open_sans", "permanent_marker", "pt_sans", "pt_sans_narrow", "pt_serif", "rammetto_one", "roboto", "roboto_condensed", "roboto_slab", "caveat", "times_new_roman", "titan_one", "lemon_tuesday", "roboto_mono", "noto_sans", "plex_sans", "plex_serif", "plex_mono", "spoof", "tiempos_text", "formular" ] }, "fontSize": { "type": "string", "description": "Font size, in dp. Default: `14`." }, "textAlign": { "type": "string", "description": "Horizontal alignment for the item's content. Default: `center.`", "enum": [ "left", "right", "center" ] } } } }, "required": [ "PCID", "board_id", "data" ] } ``` *** ## miro\_items\_delete\_app\_card\_item Delete app card item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | -------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to delete an item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to delete an item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to delete." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_delete\_card\_item Delete card item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to delete the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to delete." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_delete\_code\_widget\_item Delete code widget item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to delete the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to delete." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_delete\_doc\_format\_item Delete doc format item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to delete the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to delete." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_delete\_document\_item Delete document item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to delete the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to delete." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_delete\_embed\_item Delete embed item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to delete the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to delete." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_delete\_image\_item Delete image item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to delete the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to delete." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_delete\_shape\_item Delete shape item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to delete the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to delete." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_delete\_sticky\_note\_item Delete sticky note item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to delete the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to delete." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_delete\_text\_item Delete text item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to delete the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to delete. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to delete the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to delete." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_get\_app\_card\_item Get app card item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to retrieve." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_get\_card\_item Get card item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to retrieve." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_get\_code\_widget\_item Get code widget item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to retrieve." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_get\_code\_widget\_items Get code widget items **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `limit` | string | No | — | The maximum number of results to return per call. If the number of items in the response is greater than the limit specified, the response returns the cursor parameter with a value. | | `cursor` | string | No | — | A cursor-paginated method returns a portion of the total set of results based on the limit specified and a `cursor` that points to the next portion of the results. To retrieve the next portion of the collection, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request. | | `board_id` | string | Yes | — | Unique identifier (ID) of the board for which you want to retrieve the list of code widget items. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "limit": { "type": "string", "description": "The maximum number of results to return per call. If the number of items in the response is greater than the limit specified, the response returns the cursor parameter with a value." }, "cursor": { "type": "string", "description": "A cursor-paginated method returns a portion of the total set of results based on the limit specified and a `cursor` that points to the next portion of the results. To retrieve the next portion of the collection, set the `cursor` parameter equal to the `cursor` value you received in the response of the previous request." }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board for which you want to retrieve the list of code widget items." } }, "required": [ "PCID", "board_id" ] } ``` *** ## miro\_items\_get\_doc\_format\_item Get doc format item **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. | | `textContentType` | string | No | — | Controls the contentType of the returned doc's content. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to retrieve." }, "textContentType": { "type": "string", "description": "Controls the contentType of the returned doc's content.", "enum": [ "html", "markdown" ] } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_get\_document\_item Get document item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to retrieve." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_get\_embed\_item Get embed item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to retrieve." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_get\_image\_item Get image item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to retrieve." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_get\_shape\_item Get shape item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to retrieve." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_get\_sticky\_note\_item Get sticky note item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to retrieve." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_get\_text\_item Get text item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board from which you want to retrieve a specific item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to retrieve. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board from which you want to retrieve a specific item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to retrieve." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_move\_code\_widget\_item Move code widget item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to move the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to move. | | `x` | number | No | — | 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` | number | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to move the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to move." }, "x": { "type": "number", "description": "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": { "type": "number", "description": "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." } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_update\_app\_card\_item Update app card item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | Contains app card item data, such as the title, description, or fields. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or height. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | | `style` | object | No | — | Contains information about the style of an app card item, such as the fill color. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "type": "object", "description": "Contains app card item data, such as the title, description, or fields.", "properties": { "description": { "type": "string", "description": "A short text description to add context about the app card." }, "fields": { "type": "array", "items": { "type": "object" }, "description": "Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view." }, "status": { "type": "string", "description": "Status indicating whether an app card is connected and in sync with the source. When the source for the app card is deleted, the status returns `disabled`.", "enum": [ "disconnected", "connected", "disabled" ] }, "title": { "type": "string", "description": "A short text header to identify the app card." } } }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or height.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "rotation": { "type": "number", "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", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } }, "style": { "type": "object", "description": "Contains information about the style of an app card item, such as the fill color.", "properties": { "fillColor": { "type": "string", "description": "Hex value of the border color of the app card." } } } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_update\_card\_item Update card item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | Contains card item data, such as the title, description, due date, or assignee ID. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or height. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | | `style` | object | No | — | Contains information about the style of a card item, such as the card theme. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "type": "object", "description": "Contains card item data, such as the title, description, due date, or assignee ID.", "properties": { "assigneeId": { "type": "string", "description": "Unique user identifier. In the GUI, the user ID is mapped to the name of the user who is assigned as the owner of the task or activity described in the card. The identifier is numeric, and it is automatically assigned to a user when they first sign up." }, "description": { "type": "string", "description": "A short text description to add context about the card." }, "dueDate": { "type": "string", "description": "The date when the task or activity described in the card is due to be completed. In the GUI, users can select the due date from a calendar. 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))." }, "title": { "type": "string", "description": "A short text header for the card." } } }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or height.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "rotation": { "type": "number", "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", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } }, "style": { "type": "object", "description": "Contains information about the style of a card item, such as the card theme.", "properties": { "cardTheme": { "type": "string", "description": "Hex value of the border color of the card." } } } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_update\_code\_widget\_item Update code widget item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | Contains the data properties of a code widget item, such as the code content, programming language, and display settings. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or height. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "type": "object", "description": "Contains the data properties of a code widget item, such as the code content, programming language, and display settings.", "properties": { "code": { "type": "string", "description": "The code content of the widget." }, "language": { "type": "string", "description": "The programming language of the code content. Used for syntax highlighting." }, "lineNumbersVisible": { "type": "boolean", "description": "Indicates whether line numbers are visible in the code widget." }, "title": { "type": "string", "description": "The title of the code widget." } } }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or height.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "rotation": { "type": "number", "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", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_update\_document\_item\_using\_file\_from\_device Update document item using file from device **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `board_id_PlatformFileUpload` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | The data value | | `resource` | string | Yes | — | Select a file to upload. Maximum file size is 6 MB. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id_PlatformFileUpload": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "Title for the document." }, "altText": { "type": "string", "description": "A description (alt-text) to help people understand what is depicted here." }, "position": { "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." }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time." }, "parent": { "type": "object", "description": "Contains information about the parent frame for the item." } } }, "resource": { "type": "string", "description": "Select a file to upload. Maximum file size is 6 MB." } }, "required": [ "PCID", "board_id_PlatformFileUpload", "item_id", "resource" ] } ``` *** ## miro\_items\_update\_document\_item\_using\_url Update document item using URL **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | Contains information about the document URL. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "type": "object", "description": "Contains information about the document URL.", "properties": { "title": { "type": "string", "description": "A short text header to identify the document." }, "url": { "type": "string", "description": "URL where the document is hosted." } } }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "width": { "type": "number", "description": "Width of the item, in pixels." }, "rotation": { "type": "number", "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." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_update\_embed\_item Update embed item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | Contains information about the embed URL. | | `geometry` | object | No | — | 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 | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "type": "object", "description": "Contains information about the embed URL.", "properties": { "mode": { "type": "string", "description": "Defines how the content in the embed item is displayed on the board. `inline`: The embedded content is displayed directly on the board. `modal`: The embedded content is displayed inside a modal overlay on the board.", "enum": [ "inline", "modal" ] }, "previewUrl": { "type": "string", "description": "URL of the image to be used as the preview image for the embedded item." }, "url": { "type": "string", "description": "A [valid URL](https://developers.miro.com/reference/data#embeddata) pointing to the content resource that you want to embed in the board. Possible transport protocols: HTTP, HTTPS." } } }, "geometry": { "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", "description": "Height of the item, in pixels." }, "width": { "type": "number", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_update\_image\_item\_using\_file\_from\_device Update image item using file from device **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------- | | `board_id_PlatformFileUpload` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | The data value | | `resource` | string | Yes | — | Select a file to upload. Maximum file size is 6 MB. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id_PlatformFileUpload": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "type": "object", "description": "The data value", "properties": { "title": { "type": "string", "description": "Title for the document." }, "altText": { "type": "string", "description": "A description (alt-text) to help people understand what is depicted here." }, "position": { "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." }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time." }, "parent": { "type": "object", "description": "Contains information about the parent frame for the item." } } }, "resource": { "type": "string", "description": "Select a file to upload. Maximum file size is 6 MB." } }, "required": [ "PCID", "board_id_PlatformFileUpload", "item_id", "resource" ] } ``` *** ## miro\_items\_update\_image\_item\_using\_url Update image item using URL **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | Contains information about the image URL. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "type": "object", "description": "Contains information about the image URL.", "properties": { "title": { "type": "string", "description": "A short text header to identify the image." }, "url": { "type": "string", "description": "URL of the image." } } }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or rotation. You can set either the width or height, you cannot set both the width and height at the same time.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "width": { "type": "number", "description": "Width of the item, in pixels." }, "rotation": { "type": "number", "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." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_update\_shape\_item Update shape item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | Contains shape item data, such as the content or the type of the shape. | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or height. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | | `style` | object | No | — | Contains information about the shape style, such as the border color or opacity. \
All properties in style object are supported for shape types aren't listed below. \
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \
Shape type\Unsupported properties\
flow\_chart\_or\fontSize, fontFamily, color, textAlign, textAlignVertical\
flow\_chart\_summing\_junction\fontSize, fontFamily, color, textAlign, textAlignVertical\
flow\_chart\_note\_curly\_left\fillColor, fillOpacity\
flow\_chart\_note\_curly\_right\fillColor, fillOpacity\
flow\_chart\_note\_square\fillColor, fillOpacity\
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "type": "object", "description": "Contains shape item data, such as the content or the type of the shape.", "properties": { "content": { "type": "string", "description": "The text you want to display on the shape. **Note: When updating a shape type to one of the types below, existing `content` will be lost.**
**Not supported for shapes:** " }, "shape": { "type": "string", "description": "Defines the geometric shape of the item when it is rendered on the board.
Basic shapes
Flowchart shapes
" } } }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or height.", "properties": { "height": { "type": "number", "description": "Height of the item, in pixels." }, "rotation": { "type": "number", "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", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } }, "style": { "type": "object", "description": "Contains information about the shape style, such as the border color or opacity.
All properties in style object are supported for shape types aren't listed below.
Shape type Unsupported properties
flow_chart_or fontSize, fontFamily, color, textAlign, textAlignVertical
flow_chart_summing_junction fontSize, fontFamily, color, textAlign, textAlignVertical
flow_chart_note_curly_left fillColor, fillOpacity
flow_chart_note_curly_right fillColor, fillOpacity
flow_chart_note_square fillColor, fillOpacity
", "properties": { "borderColor": { "type": "string", "description": "Defines the color of the border of the shape." }, "borderOpacity": { "type": "string", "description": "Defines the opacity level of the shape border. Possible values: any number between `0.0` and `1.0`, where: `0.0`: the background color is completely transparent or invisible `1.0`: the background color is completely opaque or solid" }, "borderStyle": { "type": "string", "description": "Defines the style used to represent the border of the shape.", "enum": [ "normal", "dotted", "dashed" ] }, "borderWidth": { "type": "string", "description": "Defines the thickness of the shape border, in dp." }, "color": { "type": "string", "description": "Hex value representing the color for the text within the shape item." }, "fillColor": { "type": "string", "description": "Fill color for the shape. Hex values: `#f5f6f8` `#d5f692` `#d0e17a` `#93d275` `#67c6c0` `#23bfe7` `#a6ccf5` `#7b92ff` `#fff9b1` `#f5d128` `#ff9d48` `#f16c7f` `#ea94bb` `#ffcee0` `#b384bb` `#000000`" }, "fillOpacity": { "type": "string", "description": "Opacity level of the fill color. Possible values: any number between `0` and `1`, where: `0.0`: the background color is completely transparent or invisible `1.0`: the background color is completely opaque or solid" }, "fontFamily": { "type": "string", "description": "Defines the font type for the text in the shape item.", "enum": [ "arial", "abril_fatface", "bangers", "eb_garamond", "georgia", "graduate", "gravitas_one", "fredoka_one", "nixie_one", "open_sans", "permanent_marker", "pt_sans", "pt_sans_narrow", "pt_serif", "rammetto_one", "roboto", "roboto_condensed", "roboto_slab", "caveat", "times_new_roman", "titan_one", "lemon_tuesday", "roboto_mono", "noto_sans", "plex_sans", "plex_serif", "plex_mono", "spoof", "tiempos_text", "formular" ] }, "fontSize": { "type": "string", "description": "Defines the font size, in dp, for the text on the shape." }, "textAlign": { "type": "string", "description": "Defines how the sticky note text is horizontally aligned.", "enum": [ "left", "right", "center" ] }, "textAlignVertical": { "type": "string", "description": "Defines how the sticky note text is vertically aligned.", "enum": [ "top", "middle", "bottom" ] } } } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_update\_sticky\_note\_item Update sticky note item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | Contains sticky note item data, such as the content or shape of the sticky note. | | `geometry` | object | No | — | 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 | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | | `style` | object | No | — | Contains information about the style of a sticky note item, such as the fill color or text alignment. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "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." }, "shape": { "type": "string", "description": "Defines the geometric shape of the sticky note and aspect ratio for its dimensions.", "enum": [ "square", "rectangle" ] } } }, "geometry": { "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", "description": "Height of the item, in pixels." }, "width": { "type": "number", "description": "Width of the item, in pixels." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } }, "style": { "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.", "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.", "enum": [ "left", "right", "center" ] }, "textAlignVertical": { "type": "string", "description": "Defines how the sticky note text is vertically aligned.", "enum": [ "top", "middle", "bottom" ] } } } }, "required": [ "PCID", "board_id", "item_id" ] } ``` *** ## miro\_items\_update\_text\_item Update text item **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `board_id` | string | Yes | — | Unique identifier (ID) of the board where you want to update the item. | | `item_id` | string | Yes | — | Unique identifier (ID) of the item that you want to update. | | `data` | object | No | — | Contains text item data, such as the title, content, or description. For more information on the JSON properties, see [Data](https://developers.miro.com/reference/data). | | `geometry` | object | No | — | Contains geometrical information about the item, such as its width or rotation. You can only specify the width of the text item as the height is dynamically updated based on the content. | | `parent` | object | No | — | Contains information about the parent frame for the item. | | `position` | object | No | — | 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. | | `style` | object | No | — | Contains information about the style of a text item, such as the fill color or font family. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "board_id": { "type": "string", "description": "Unique identifier (ID) of the board where you want to update the item." }, "item_id": { "type": "string", "description": "Unique identifier (ID) of the item that you want to update." }, "data": { "type": "object", "description": "Contains text item data, such as the title, content, or description. For more information on the JSON properties, see [Data](https://developers.miro.com/reference/data).", "properties": { "content": { "type": "string", "description": "The actual text (content) that appears in the text item." } }, "required": [ "content" ] }, "geometry": { "type": "object", "description": "Contains geometrical information about the item, such as its width or rotation. You can only specify the width of the text item as the height is dynamically updated based on the content.", "properties": { "rotation": { "type": "number", "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", "description": "Width of the item, in pixels. The minimum `width` of a `text` widget is relative to the font size of the `text` widget. The width must be at least 1.7 times wider than the font size. For example, if the font size of the `text` item is `14`, the minimum `width` is `24`." } } }, "parent": { "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." } } }, "position": { "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", "description": "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": { "type": "number", "description": "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." } } }, "style": { "type": "object", "description": "Contains information about the style of a text item, such as the fill color or font family.", "properties": { "color": { "type": "string", "description": "Hex value representing the color for the text within the text item." }, "fillColor": { "type": "string", "description": "Background color of the text item." }, "fillOpacity": { "type": "string", "description": "Opacity level of the background color. Possible values: any number between `0.0` and `1.0`, where: `0.0`: the background color is completely transparent or invisible `1.0`: the background color is completely opaque or solid" }, "fontFamily": { "type": "string", "description": "Font type for the text in the text item.", "enum": [ "arial", "abril_fatface", "bangers", "eb_garamond", "georgia", "graduate", "gravitas_one", "fredoka_one", "nixie_one", "open_sans", "permanent_marker", "pt_sans", "pt_sans_narrow", "pt_serif", "rammetto_one", "roboto", "roboto_condensed", "roboto_slab", "caveat", "times_new_roman", "titan_one", "lemon_tuesday", "roboto_mono", "noto_sans", "plex_sans", "plex_serif", "plex_mono", "spoof", "tiempos_text", "formular" ] }, "fontSize": { "type": "string", "description": "Font size, in dp." }, "textAlign": { "type": "string", "description": "Horizontal alignment for the item's content.", "enum": [ "left", "right", "center" ] } } } }, "required": [ "PCID", "board_id", "item_id" ] } ```