Update organization guest documentation default

Sets the organization default for guest documentation publication. Hidden, AllPages, or SelectedPages. Projects inherit this value until they set an override. This does not grant project access or documentation-management permission.

PATCH/organizations/{id}/guest-access

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Request body

requiredapplication/json

guestDocumentationVisibilitystringrequired

Organization default for guest documentation publication. This does not grant project access.

Allowed:HiddenAllPagesSelectedPages

Responses

200

successbooleanrequired

Operation success flag

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

idpath*

Bodyapplication/json

guestDocumentationVisibilitystring*Organization default for guest documentation publication. This does not grant project access.

Request

curl -X PATCH "https://leadtime.app/api/public/organizations/string/guest-access" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "guestDocumentationVisibility": "Hidden"
}'

const response = await fetch("https://leadtime.app/api/public/organizations/string/guest-access", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"guestDocumentationVisibility\": \"Hidden\"\n}"
});

import requests

response = requests.patch(
    "https://leadtime.app/api/public/organizations/string/guest-access",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"guestDocumentationVisibility\": \"Hidden\"\n}",
)

Response

{
  "success": true
}