Microboard.Developers
ApiShapes

Update a shape

PATCH
/developers/boards/{boardId}/shapes/{itemId}

Authorization

apiKey<token>

In: query

Request Body

application/jsonRequired
shapeTypestring
Value in: "RoundedRectangle" | "Circle" | "Triangle" | "Rhombus"
backgroundColorstring
backgroundOpacitynumber
Minimum: 0Maximum: 1
borderColorstring
borderStylestring
Value in: "solid" | "dot" | "dash" | "longDash" | "dotDash" | "tripleDotDash" | "looseDoubleDotDash"
borderWidthnumber
Minimum: 0

Path Parameters

boardId
Required
string
itemId
Required
string
curl -X PATCH "https://api.microboard.com/api/v1/developers/boards/string/shapes/string" \
  -H "apiKey: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "backgroundColor": "#ff0000",
    "borderStyle": "dash",
    "borderWidth": 2
  }'

Shape updated successfully

{
  "id": "string",
  "itemType": "Shape",
  "transformation": {
    "rotate": 0,
    "scaleX": 1,
    "scaleY": 1,
    "translateX": 0,
    "translateY": 0
  },
  "text": {
    "children": [
      {
        "type": "paragraph",
        "children": [
          {
            "text": "string",
            "type": "text",
            "fontSize": 14,
            "fontColor": "black",
            "fontFamily": "Arial",
            "lineHeight": 1.4,
            "bold": false,
            "italic": false,
            "underline": false,
            "lineThrough": false,
            "fontHighlight": ""
          }
        ],
        "horisontalAlignment": "left"
      }
    ],
    "insideOf": "Frame",
    "itemType": "RichText",
    "realSize": 0,
    "placeholderText": "string",
    "containerMaxWidth": 0,
    "verticalAlignment": "center"
  }
}

Previous

Create a rich text POST

Next

Create a shape POST