Workspaces

Update a workspace

Rename, change mode, or change visibility. Editor or owner role required.

patch/api/workspaces/{slug}

Request

  • Base URL
    https://trydock.ai
  • Auth
    HTTP bearer

Path parameters

slugstring required

Request body

namestring
visibility'private' | 'org' | 'unlisted' | 'public'

Who can see and edit. private = explicit members only. org = every org member is virtual editor. unlisted = anyone with the URL can read. public = indexed by search.

mode'table' | 'doc'

Default-view hint (which tab opens first). A workspace can hold any combination of table + doc surfaces regardless of mode.

Response

Updated.

Example response

{
  "workspace": {
    "id": "ws_01J5Z6Q7…",
    "slug": "launch-plan",
    "name": "Launch plan",
    "primarySurface": {
      "id": "srf_01J5Z…",
      "slug": "table"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.