ApiRoomsIdCanvasDocumentid
Change one document on a room’s canvas
Three independent changes, any of which may be omitted: replace what the document shows, pin or unpin it, and move it to the front of the list. activate changes the ORDER and nobody's open tab. A shared canvas that yanked everyone's view when somebody clicked would be the pixel version of interrupting, so ordering on the server is not a remote-control verb. Refused on an archived room, and refused while another member is editing the document.
Path Parameters
id*string
Length
1 <= lengthdocumentId*string
Length
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/rooms/string/canvas/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "scope": "string", "roomId": "string", "content": { "type": "url", "url": "http://example.com", "title": "string" }, "title": "string", "contentType": "string", "authorId": "string", "pinned": true, "rev": 0, "lastTouchedBy": "string", "lastTouchedAt": "string", "editingBy": "string", "sourceLabel": "string", "treeKind": "room-main", "aheadOfMain": 0, "openedAt": "string", "lastActiveAt": "string", "threadRootEntryId": "string"}