Sign in
latestOpenAPI 3.0.0Superhuman Developer Terms2026-08-19124404444.2 KB

22273737ad50

Publishing

Publish doc

Update publish settings for a doc.

put/docs/{docId}/publish

Path parameters

docIdstring required

ID of the doc.

Request body

slugstring

Slug for the published doc.

discoverableboolean

If true, indicates that the doc is discoverable.

categoryNamesstring[]

The names of categories to apply to the document.

mode'view' | 'play' | 'edit'

Which interaction mode the published doc should use.

Example request

{
  "slug": "my-doc",
  "discoverable": true,
  "categoryNames": [
    "Project management"
  ]
}

Response

Confirmation that the publish request was accepted.

requestIdstring required

An arbitrary unique identifier for this request.

Example response

{
  "requestId": "abc-123-def-456"
}