Create document share

POST/workspaces/{organizationId}/documents/{id}/share

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

includeChildrenboolean

expiresAtstring

Responses

201Share link created

tokenstringrequired

documentIdstringrequired

includeChildrenbooleanrequired

createdAtstringrequired

expiresAtstring | nullrequired

404Document not found

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*idpath*

Bodyapplication/json

includeChildrenbooleanexpiresAtstring

Request

curl -X POST "/workspaces/string/documents/string/share" \
  -H "Content-Type: application/json" \
  -d '{
  "includeChildren": true,
  "expiresAt": "string"
}'

const response = await fetch("/workspaces/string/documents/string/share", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"includeChildren\": true,\n  \"expiresAt\": \"string\"\n}"
});

import requests

response = requests.post(
    "/workspaces/string/documents/string/share",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"includeChildren\": true,\n  \"expiresAt\": \"string\"\n}",
)

Response

{
  "token": "string",
  "documentId": "string",
  "includeChildren": true,
  "createdAt": "string",
  "expiresAt": "string"
}