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

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

guestAccessbooleanMaster switch for organization-member project access.guestDocumentationVisibilitystringProject override for guest documentation publication. Null inherits the organization default. Omit to leave unchanged.

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: "{\n  \"guestAccess\": true,\n  \"guestDocumentationVisibility\": \"Hidden\"\n}"
});

import requests

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

Response

{
  "success": true
}