Move, resize, replace data or reply

PATCH /boards/{boardId}/items/{itemId}

Updated 16 Sep 20263 min read

PATCH/boards/{boardId}/items/{itemId}Try it

Basehttps://api.mockflow.com/v1Scopesboards:write

Request

curl https://api.mockflow.com/v1/boards/brd_3f9e2a/items/itm_k9 \
  -X PATCH \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "position": {
    "x": 0,
    "y": 0
  },
  "size": {
    "width": 0,
    "height": 0
  },
  "data": {
    "files": {},
    "merge": false,
    "deletes": [
      "string"
    ],
    "order": [
      "string"
    ],
    "html": "string",
    "data": {}
  },
  "reply": "string"
}'

const response = await fetch("https://api.mockflow.com/v1/boards/brd_3f9e2a/items/itm_k9", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "position": {
    "x": 0,
    "y": 0
  },
  "size": {
    "width": 0,
    "height": 0
  },
  "data": {
    "files": {},
    "merge": false,
    "deletes": [
      "string"
    ],
    "order": [
      "string"
    ],
    "html": "string",
    "data": {}
  },
  "reply": "string"
})
});

const data = await response.json();

import os, requests

response = requests.patch(
    "https://api.mockflow.com/v1/boards/brd_3f9e2a/items/itm_k9",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
    json={
  "position": {
    "x": 0,
    "y": 0
  },
  "size": {
    "width": 0,
    "height": 0
  },
  "data": {
    "files": {},
    "merge": False,
    "deletes": [
      "string"
    ],
    "order": [
      "string"
    ],
    "html": "string",
    "data": {}
  },
  "reply": "string"
},
)

response.raise_for_status()
data = response.json()

Response

{
  "id": "itm_k9",
  "type": "string",
  "componentType": "string",
  "boardId": "brd_3f9e2a",
  "sectionId": "string",
  "groupId": "string"
}

{
  "id": "job_7hd2",
  "kind": "item.create",
  "status": "queued",
  "progress": 0,
  "message": "Interview 5 users",
  "result": {
    "itemIds": [
      "string"
    ],
    "updated": [
      "string"
    ],
    "deleted": [
      "string"
    ],
    "creditsUsed": 0,
    "boardTitle": "Q4 Launch Planning",
    "skill": "string"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#rate_limited"
  },
  "requestId": "req_45d49816999bac40"
}

position and size move and resize any item. data replaces a frame's content in place, for the types drawn as a single component (kanban, mindmap, markdown, checklist, gantt, timeline and the rest of the frames); a flowchart or a whiteboard is many components and answers 409. reply adds to a comment's thread. z-order, group and lock are not changed through the API in this version.

Authorization

Authorizationstringheaderrequired

Bearer <key>. The key needs boards:write scope. Create and manage keys in the developer console; what each scope unlocks is on the scopes page.

Path parameters

boardIdstringpathrequired

itemIdstringpathrequired

Body

application/json

positionPoint

Child attributes

xnumberrequired

ynumberrequired

sizeSize

Child attributes

widthnumber

heightnumber

dataItemData

Selected by the sibling type. One schema per item type, generated from the component registry.

replystring

Comments only: add a reply to the thread.

Response

200 · application/json

idstring

typestring

An ItemType, or other for an editor widget the API has no type for.

componentTypestring

The editor's own class name, exact where type is a family.

boardIdstring

sectionIdstring | null

The section the item sits inside, by position.

groupIdstring | null

positionPoint

Child attributes

xnumberrequired

ynumberrequired

sizeSize

Child attributes

widthnumber

heightnumber

rotationnumber

zIndexinteger

lockedboolean

textstring

Plain text extracted from the item, for search and the outline.

readbackenum<string>

One of exact, unwrapped, text, pointer, parts or none.

dataItemData

Selected by the sibling type. One schema per item type, generated from the component registry.

fromstring | null

Connectors only: the item or group: the line starts at.

tostring | null

Connectors only.

directedboolean

Connectors only.

labelstring

Connectors only.

urlstring

Opens the board focused on this item.

Errors

429rate_limited

Too many requests.

Was this page helpful?