Update document space

PATCH/workspaces/{organizationId}/document-spaces/{id}

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

namestring

min length 1

descriptionstring | null

iconstring | null

publicSharingboolean

Responses

200Space updated

idstringrequired

organizationIdstringrequired

namestringrequired

descriptionstring | nullrequired

iconstring | nullrequired

publicSharingbooleanrequired

createdByIdstringrequired

createdAtstringrequired

404Space not found

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*idpath*

Bodyapplication/json

namestringdescriptionstringiconstringpublicSharingboolean

Request

curl -X PATCH "/workspaces/string/document-spaces/string" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "icon": "string",
  "publicSharing": true
}'

const response = await fetch("/workspaces/string/document-spaces/string", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"icon\": \"string\",\n  \"publicSharing\": true\n}"
});

import requests

response = requests.patch(
    "/workspaces/string/document-spaces/string",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"icon\": \"string\",\n  \"publicSharing\": true\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "description": "string",
  "icon": "string",
  "publicSharing": true,
  "createdById": "string",
  "createdAt": "string"
}