Skip to content
em sa em sa

Enable Collab

POST
/api/canvas/{deal_id}/collab/enable
 
curl --request POST \
  --url https://example.com/api/canvas/example/collab/enable \
  --header 'Authorization: Bearer <token>'

Enable OT collaborative editing for a document.

Converts the current markdown to a ProseMirror document, initializes the collab authority, and sets collab_enabled=True on the session. Broadcasts DOCUMENT_STATE_CHANGED so all connected clients switch modes.

Phase C2: RequireOwner — only deal owners can toggle collab mode.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
deal_id
required
Deal Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
EnableCollabResponse

Response for POST /api/canvas/{deal_id}/collab/enable.

object
success
required
Success
boolean
collab_enabled
required
Collab Enabled
boolean
version
required
Version
integer
Example generated
{
  "success": true,
  "collab_enabled": true,
  "version": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}