YOWO7 API
Knowledge
PATCH

/api/v1/workspaces/{workspaceId}/knowledge/sites/{siteId}

Scope knowledge:write

Update a knowledge site: enabled state, locales, style set, home copy, footer links, and calls to action. The public slug stays as it was created.

Pfad

siteIdPflicht
string (uuid)
Knowledge site identifier.
workspaceIdPflicht
string
Workspace that owns the resource.

Request

application/json · UpdateKnowledgeSiteRequestDto

name
string
Display name.
isEnabled
boolean
Whether this is enabled.
isPrimary
boolean
Whether this is primary.
kind
KnowledgeSiteKind
defaultLocale
string
Default locale.
locales
string[]
Language codes this item is available in.
allowAnonymousComments
boolean
Whether to allow anonymous comments.
styleSetId
string (uuid)
Identifier of the style set.
clearStyleSet
boolean
Whether to clear the style set.
homeCopy
object
homeTitle
string
Home title.
homeDescription
string
Home description.
contactUrl
string
URL of the contact.
ctaAboveId
string (uuid)
Identifier of the cta above.
clearCtaAbove
boolean
Whether to clear the cta above.
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.
footerLinks
object
apiSnippetLanguages
string[]
API snippet languages.

Antworten

200KnowledgeSiteDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

Knowledge site.

id
string (uuid)
Identifier.
name
string
Display name.
publicSlug
string
Public slug.
isEnabled
boolean
Whether this is enabled.
isPrimary
boolean
Whether this is primary.
kind
KnowledgeSiteKind
defaultLocale
string
Default locale.
locales
string[]
Language codes this item is available in.
allowAnonymousComments
boolean
Whether to allow anonymous comments.
styleSetId
string (uuid)
Identifier of the style set.
preferredHostnameId
string (uuid)
Identifier of the preferred hostname.
homeCopy
object
homeTitle
string
Home title.
homeDescription
string
Home description.
contactUrl
string
URL of the contact.
ctaAboveId
string (uuid)
Identifier of the cta above.
ctaSidebarId
string (uuid)
Identifier of the cta sidebar.
ctaBelowId
string (uuid)
Identifier of the cta below.
footerLinks
object
fallbackHostname
string
Fallback hostname.
fallbackHostnameStatus
string
Fallback hostname status.
apiSnippetLanguages
string[]
API snippet languages.
400ApiProblemThe request is invalid.
401ApiProblemThe private app token is missing or invalid.
403ApiProblemThe token is missing the required scope, or this action is not allowed.
404ApiProblemThe workspace or resource was not found.
defaultApiProblemError response.
Update a knowledge site · YOWO7 API