Knowledge
PATCH
/api/v1/workspaces/{workspaceId}/knowledge/sites/{siteId}/pages/{pageId}
Scope knowledge:write
Update knowledge page metadata: title, slug, parent, sort order, comments, SEO, highlight, and calls to action.
Pfad
siteIdPflicht
string (uuid)
Knowledge site identifier.
pageIdPflicht
string (uuid)
Page identifier.
workspaceIdPflicht
string
Workspace that owns the resource.
Request
application/json · UpdateKnowledgePageRequestDto
title
string
Title.
slug
string
Stable slug used in paths and API calls.
parentPageId
string (uuid)
Identifier of the parent page.
sortOrder
integer (int32)
Order among siblings. Lower numbers come first.
commentsEnabled
boolean
Whether comments enabled is set.
draftMetaDescription
string
Draft meta description.
draftSeoTitle
string
Draft seo title.
draftExcerpt
string
Draft excerpt.
draftNoIndex
boolean
Whether draft no index is set.
isFeatured
boolean
Whether this is featured.
featuredOrder
integer (int32)
Featured order.
ctaSidebarId
string (uuid)
Identifier of the cta sidebar.
clearCtaSidebar
boolean
Whether to clear the cta sidebar.
ctaBelowId
string (uuid)
Identifier of the cta below.
clearCtaBelow
boolean
Whether to clear the cta below.
Antworten
200KnowledgePageDetailDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.
Knowledge page detail.
id
string (uuid)
Identifier.
scope
siteId
string (uuid)
Identifier of the site.
parentPageId
string (uuid)
Identifier of the parent page.
sortOrder
integer (int32)
Order among siblings. Lower numbers come first.
path
string
Path.
depth
integer (int32)
Depth.
translationGroupId
string (uuid)
Identifier of the translation group.
locale
string
Language code.
draftTitle
string
Draft title.
draftSlug
string
Draft slug.
draftContentJson
string
JSON for the draft content.
draftMetaDescription
string
Draft meta description.
draftSeoTitle
string
Draft seo title.
draftExcerpt
string
Draft excerpt.
draftNoIndex
boolean
Whether draft no index is set.
draftCoverUrl
string
URL of the draft cover.
publishedTitle
string
Published title.
publishedSlug
string
Published slug.
publishedContentJson
string
JSON for the published content.
publishedMetaDescription
string
Published meta description.
publishedSeoTitle
string
Published seo title.
publishedExcerpt
string
Published excerpt.
publishedNoIndex
boolean
Whether published no index is set.
publishedCoverUrl
string
URL of the published cover.
status
hasUnpublishedChanges
boolean
Whether unpublished changes is set.
commentsEnabled
boolean
Whether comments enabled is set.
isFeatured
boolean
Whether this is featured.
featuredOrder
integer (int32)
Featured order.
ctaSidebarId
string (uuid)
Identifier of the cta sidebar.
ctaBelowId
string (uuid)
Identifier of the cta below.
publishedRevisionNumber
integer (int32)
Published revision number.
publishedAt
string (date-time)
When the published was recorded.
createdByUserId
string (uuid)
Member who created this.
updatedByUserId
string (uuid)
Member who last updated this.
createdAt
string (date-time)
When this was created.
updatedAt
string (date-time)
When this was last updated.
apiRef
apiFragment
apiVersions
KnowledgeApiVersionDto[]
API versions.