Update document space

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

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

namestring

min length 1

descriptionstring | null

iconstring | null

publicSharingboolean

restrictedboolean

Responses

200

Space updated

idstringrequired

organizationIdstringrequired

namestringrequired

descriptionstring | nullrequired

iconstring | nullrequired

publicSharingbooleanrequired

restrictedbooleanrequired

createdByIdstringrequired

createdAtstringrequired

404

Space not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*idpath*

Bodyapplication/json

namestringdescriptionstringiconstringpublicSharingbooleanrestrictedboolean

Request

curl -X PATCH 'https://pile.nyc/workspaces/string/document-spaces/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "icon": "string",
  "publicSharing": true,
  "restricted": true
}'

const response = await fetch("https://pile.nyc/workspaces/string/document-spaces/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"icon\": \"string\",\n  \"publicSharing\": true,\n  \"restricted\": true\n}"
});

import requests

response = requests.patch(
    "https://pile.nyc/workspaces/string/document-spaces/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"icon\": \"string\",\n  \"publicSharing\": true,\n  \"restricted\": true\n}",
)

Response

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