Update a docs project

Update project settings. Set isPrivate with accessGroups to put the site behind a login.

OAuth scopes

platform:write

Path Parameters

slug
Type: string
required

Body

required

application/json

accessGroups
Type: …50
min length:
5
activeThemeId
Type:
min length:
5
agentEnabled
Type: boolean
analyticsEnabled
Type: boolean
isPrivate
Type: boolean
loginPortalUid
Type:
min length:
5
name
Type: string

Responses

application/json
application/json
application/json
application/json
application/json
application/json
application/json

patch/v1/docs/{slug}

curl https://access.scalar.com/v1/docs/acme-docs \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "name": "Acme Documentation",
  "isPrivate": false,
  "accessGroups": [
    "UakgbKJ5m9gl0JDMbcJqL"
  ],
  "loginPortalUid": "LakgbKJ5m9gl0JDMbcJqL",
  "activeThemeId": "TakgbKJ5m9gl0JDMbcJqL",
  "agentEnabled": true,
  "analyticsEnabled": true
}'

Show Schema

null

Default Response

Delete a docs project

Publish a docs project

The API company.