Websites
PATCH
/api/v1/workspaces/{workspaceId}/websites/{websiteId}
Scope websites:write
Update a marketing website: name, enabled state, locales, style set, header, footer, and analytics ids.
Pfad
websiteIdPflicht
string (uuid)
Website identifier.
workspaceIdPflicht
string
Workspace that owns the resource.
Request
application/json · UpdateWebsiteRequestDto
name
string
Display name.
isEnabled
boolean
Whether this is enabled.
defaultLocale
string
Default locale.
locales
string[]
Language codes this item is available in.
styleSetId
string (uuid)
Identifier of the style set.
clearStyleSet
boolean
Whether to clear the style set.
colorScheme
headerJson
string
JSON for the header.
footerJson
string
JSON for the footer.
consentJson
string
JSON for the consent.
googleAnalyticsId
string
Identifier of the google analytics.
googleTagManagerId
string
Identifier of the google tag manager.
faviconFileId
string (uuid)
Identifier of the favicon file.
clearFavicon
boolean
Whether to clear the favicon.
bodyFontFileId
string (uuid)
Identifier of the body font file.
clearBodyFont
boolean
Whether to clear the body font.
headingFontFileId
string (uuid)
Identifier of the heading font file.
clearHeadingFont
boolean
Whether to clear the heading font.
notFoundPageId
string (uuid)
Identifier of the not found page.
clearNotFoundPage
boolean
Whether to clear the not found page.
Antworten
200WebsiteDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.
Website.
id
string (uuid)
Identifier.
name
string
Display name.
publicSlug
string
Public slug.
isEnabled
boolean
Whether this is enabled.
styleSetId
string (uuid)
Identifier of the style set.
preferredHostnameId
string (uuid)
Identifier of the preferred hostname.
defaultLocale
string
Default locale.
locales
string[]
Language codes this item is available in.
colorScheme
headerJson
string
JSON for the header.
footerJson
string
JSON for the footer.
consentJson
string
JSON for the consent.
googleAnalyticsId
string
Identifier of the google analytics.
googleTagManagerId
string
Identifier of the google tag manager.
faviconFileId
string (uuid)
Identifier of the favicon file.
bodyFontFileId
string (uuid)
Identifier of the body font file.
headingFontFileId
string (uuid)
Identifier of the heading font file.
notFoundPageId
string (uuid)
Identifier of the not found page.
fallbackHostname
string
Fallback hostname.
fallbackHostnameStatus
createdAt
string (date-time)
When this was created.
updatedAt
string (date-time)
When this was last updated.