Items

Move, resize, replace data or reply

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.

patch/boards/{boardId}/items/{itemId}

Request

  • Base URL
    https://api.mockflow.com/v1
  • Auth
    HTTP bearer

Request body

callbackUrlstring uri

Optional. When the job this request starts finishes or fails, a short body is POSTed here once: { eventId, status, boardId, boardUrl, imageUrl }, where status is succeeded or failed and imageUrl is a picture of what the job drew, or null. Signed with the workspace's callback secret (GET /webhooks/callback-secret). https to a public host. The full job is on GET /jobs/{jobId}.

replystring

Comments only: add a reply to the thread.

Example request

{
  "callbackUrl": "https://hooks.zapier.com/hooks/standard/123/abc"
}

Response

Applied and already visible.

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 nullable

The section the item sits inside, by position.

groupIdstring nullable
rotationnumber
zIndexinteger
lockedboolean
textstring

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

readback'exact' | 'unwrapped' | 'text' | 'pointer' | 'parts' | 'none'
fromstring nullable

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

tostring nullable

Connectors only.

directedboolean

Connectors only.

labelstring

Connectors only.

urlstring uri

Opens the board focused on this item.

Example response

{
  "id": "itm_k9"
}

Changes

No recorded changes to this operation across all 1 revision of this API.