Microboard.Developers
ApiShapes

Create a shape

POST
/developers/boards/{boardId}/shapes

Authorization

apiKey<token>

In: query

Request Body

application/jsonRequired
type
Required
string
Value in: "Shape"
shapeType
Required
string
Value in: "RoundedRectangle" | "Circle" | "Triangle" | "Rhombus" | "SpeachBubble" | "Parallelogram" | "Star" | "ArrowRight" | "ArrowLeft" | "ArrowLeftRight" | "Pentagon" | "Octagon" | "Hexagon" | "PredefinedProcess" | "Trapezoid" | "Cloud" | "Cross" | "Cylinder" | "BracesRight" | "BracesLeft"
transformationobject
borderColorstring
Default: "#1a1a1a"
borderStylestring
Default: "solid"Value in: "solid" | "dot" | "dash" | "longDash" | "dotDash" | "tripleDotDash" | "looseDoubleDotDash"
borderWidthnumber
Default: 2
borderOpacitynumber
Default: 1
backgroundColorstring
Default: "transparent"
backgroundOpacitynumber
Default: 0
widthnumber
heightnumber

Path Parameters

boardId
Required
string
curl -X POST "https://api.microboard.com/api/v1/developers/boards/string/shapes" \
  -H "apiKey: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "Shape",
    "shapeType": "RoundedRectangle",
    "borderColor": "#1a1a1a",
    "backgroundColor": "#ffffff",
    "width": 200,
    "height": 100
  }'

Shape created successfully

{
  "id": "shape-123",
  "itemType": "Shape",
  "shapeType": "RoundedRectangle",
  "transformation": {
    "rotate": 0,
    "scaleX": 2,
    "scaleY": 1,
    "translateX": 100,
    "translateY": 100
  },
  "borderColor": "#1a1a1a",
  "borderStyle": "solid",
  "borderWidth": 2,
  "borderOpacity": 1,
  "backgroundColor": "#ffffff",
  "backgroundOpacity": 1
}

Previous

Update a shape PATCH

Next

Update a sticker PATCH