Microboard.Developers
ApiItemsFrames

Update a frame

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

Authorization

apiKey<token>

In: query

Request Body

application/jsonRequired
shapeTypestring
Value in: "Custom" | "Frame16x9" | "Frame4x3" | "A4" | "Letter" | "Frame1x1"
backgroundColorstring
canChangeRatioboolean

Path Parameters

boardId
Required
string
itemId
Required
string
curl -X PATCH "https://api.microboard.com/api/v1/developers/boards/string/frames/string" \
  -H "apiKey: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "shapeType": "Frame16x9",
    "backgroundColor": "#f5f5f5"
  }'

Frame 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 drawing POST

Next

Create a frame POST