Scalar
Overview

Update shared component metadata

PATCH/v1/schemas/{namespace}/{slug}
Features

Update schema metadata.

Input5
Authorizationheaderrequired
Your API key, sent as Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN.Sent from your browser straight to the API — never to Docsbook, never stored.
namespacestring · pathrequired
slugstring · pathrequired
titlestring · body
descriptionstring · body
isPrivateboolean · body
Responses
200Default Response
400Bad request
401No auth
403Forbidden
404Not found
422Invalid payload
500Uncaught error
Example input
curl -X PATCH 'https://access.scalar.com/v1/schemas/{namespace}/{slug}' \
  -H 'Authorization: Bearer YOUR_SCALAR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

Updated

Was this page helpful?