v1

Update a board

Rename / move, and/or change the diagram — either REPLACE it (diagram) or PATCH it (ops, atomic). Send If-Match: <etag> to get 412 instead of overwriting a collaborator's newer edit. A version snapshot is kept on every diagram change.

patch/api/v1/boards/{doc_id}

Request

  • Base URL: https://board.noddle.dev (the document declares no server; this is the origin it was published from)
  • URL: https://board.noddle.dev/api/v1/boards/{doc_id}
  • Auth: none declared

Path parameters

doc_idstring required

Request body

namestring nullable
folder_idstring nullable

Move into a folder; null = root.

diagramobject nullable

Replace the WHOLE diagram.

opsobject[] nullable

Patch instead of replace (atomic). Ops: {op:'add'|'update', node|edge:{id,…}}, {op:'delete', id}, {op:'add_page', page:{id,name}}, {op:'rename_page', page_id, name}; each may carry page_id (default: first page). update MERGES fields.

Response

Successful Response

idstring required
namestring required
urlstring required
created_atstring required

ISO-8601 UTC

updated_atstring required

ISO-8601 UTC

etagstring required

Opaque version tag; send as If-Match to update safely.

folder_idstring nullable
owner_idstring nullable
team_idstring nullable
link_policystring
my_rolestring required

owner | editor | viewer

diagramobject nullable

Editable board JSON: {pages:[{id,name,nodes,edges}]}

Changes

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