Skip to main content
PATCH
/
journals
/
editor
/
edit
{
  "success": true,
  "message": "<string>",
  "journal_id": "<string>",
  "results": [
    {
      "operation": "create_node",
      "success": true,
      "error": "<string>",
      "data": {
        "created": true,
        "nodeId": "<string>",
        "updated": "<string>",
        "deleted": "<string>"
      }
    }
  ],
  "timestamp": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
journal_id
string
required
​
operations
Operations · array
required
  • CreateNodeOperation
  • UpdateNodeOperation
  • DeleteNodeOperation
​
sync_realtime_state
boolean
default:true

Whether to directly update the state of the journal to all connected users. WARNING: Operations through synced states CANNOT be undone, and will remove Ctrl+Z functionality for all users for the changes

Response

Successful Response

​
success
boolean
required
​
journal_id
string
required
​
results
EditResults · object[]
required
​
message
string | null
​
timestamp
string
⌘I