Update project guest access settings

Partially updates guest access and documentation publication for one project. Omitted fields stay unchanged. Set guestDocumentationVisibility to null to inherit the organization default.

Switching Hidden, AllPages, and SelectedPages does not clear saved page and folder selections. Organization members cannot call this endpoint.

PATCH/projects/{id}/guest-access

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:write

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Request body

requiredapplication/json

guestAccessboolean

Master switch for organization-member project access.

guestDocumentationVisibilitystring | null

Project override for guest documentation publication. Null inherits the organization default. Omit to leave unchanged.

Allowed:HiddenAllPagesSelectedPages

Responses

200

successbooleanrequired

Operation success flag

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

Request

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

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

import requests

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

Response

{
  "success": true
}