MOmockflow
Items

Add a record to an item

Adds one thing to an item that holds many: a card to a kanban (in the column it names), a task to a gantt, an event to a timeline or calendar, an item to a checklist, a line to a document, a value to a chart, a row to a spreadsheet. Send the same key again and that record is updated and moved instead of added twice; without a key, a record identical to one already there changes nothing. Everything else in the item stays as it is. What a type takes is record on GET /item-types/{type}; types without it answer 409.

post/boards/{boardId}/items/{itemId}/records

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}.

Example request

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

Response

Applied and already visible, or changed false when the record was already there as sent.

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.

changedboolean

Example response

{
  "id": "itm_k9"
}

Changes

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