Changes the website’s name, theme behaviour and site-wide SEO defaults. Every field is optional; omitted fields are left alone.
supportedLocales and defaultLocale are organization-level and need the additional organization:write scope. They also decide which languages the member portal, the mobile app and outbound email offer, and they take effect immediately rather than on publish - so they are a separate grant from editing the draft. They are reachable here at all because they are what decides which localized URLs the website serves: a page or section translated into an unlisted locale has no URL to be served at and no hreflang alternate pointing to it. A defaultLocale outside supportedLocales is a 400.
Everything else in this body edits the draft, seoSettings included - it is stored in the site’s settings, so a release carries it and the public site keeps serving the previously published values until you publish.
Deliberately cannot change the site’s address (slug, domain), which website is the organization’s default, or whether the site is switched on - those move a customer’s public presence and are not side effects a content edit should have.
Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.
Query Parameters
siteId
integer
Body
application/json
name
string
themeSupport
enum<string>
both lets a visitor switch; light/dark fixes the theme.
Available options:
both,
light,
dark
defaultTheme
enum<string>
Only meaningful when themeSupport is both.
Available options:
light,
dark,
system
seoSettings
object
Site-wide SEO defaults, replacing the whole object - read the current one from GET /website first. Every field is a fallback a page can override.
Show child attributes
buttonStyle
object
How buttons look across the WHOLE website. Site-wide on purpose: a section chooses each button's emphasis (primary/secondary/outline/ghost), but a site with pill buttons in the hero and square ones in a CTA reads as broken. Unlike seoSettings this MERGES field by field, so setting the shape leaves the casing alone. An all-default style is stored as nothing, and the renderer falls back to pill.
Show child attributes
cornerRadius
enum<string> | null
How round every corner on the site is - section cards, media frames, form controls, and buttons on sharp/round. Defaults to soft, which is what every site rendered before this existed. null returns to the default.
Available options:
sharp,
soft,
round
spacing
enum<string> | null
The site's baseline vertical rhythm: the gap BETWEEN sections and the default padding inside one. A section's own paddingY overrides the padding half; the gap is the part no per-section control reaches. null returns to the default.
Available options:
compact,
default,
airy
typeScale
enum<string> | null
How large headings run relative to body text. A multiplier on the heading ladder rather than a set of sizes. null returns to the default.
Available options:
compact,
default,
editorial
clubId
integer | null
Club this website represents. When set, the header and footer use that club's logo instead of the organization's. null clears the binding. Takes effect immediately, like name — logos are branding assets rather than a published token.
supportedLocales
enum<string>[]
Locales this organization serves, in display order. Organization-level, requires organization:write, and applies immediately - see the endpoint description. Must contain defaultLocale.
Available options:
en,
es,
fr,
de,
bg,
cs
defaultLocale
enum<string>
Locale served at the site root. Organization-level, requires organization:write.
Available options:
en,
es,
fr,
de,
bg,
cs
Response
The updated website
A website belonging to the organization. Page content, layout and theme tokens describe the draft. url, published, activeReleaseVersion and lastPublishedAt describe what the public is currently being served. name and clubId are live row fields — they take effect without a publish.
id
integer
name
string
slug
string
Platform host label - the site answers on <slug>.1club.me.
domain
string | null
Custom domain, when one is pointed at this site.
isDefault
boolean
True for the site an organization-wide caller means by "the website". Exactly one per organization.
isActive
boolean
False means the site is switched off and serves nothing publicly, whatever the draft contains.
clubId
integer | null
Club this website represents. When set, the header and footer use that club's logo instead of the organization's. Live, like name.
url
string
Public URL - the custom domain when set, else the platform host.
previewUrl
string
The same site rendered from the unpublished draft - the link to review edits before publishing. Carries a signed grant that expires 24 hours after this response was generated; read the website again for a fresh one. Anyone holding the link can view the draft, so it is shareable without a login but should be treated as sensitive.
published
boolean
Whether the site has ever been published. False means nothing is publicly reachable yet.
activeReleaseVersion
integer | null
lastPublishedAt
string<date-time> | null
themeSupport
enum<string> | null
Available options:
both,
light,
dark
defaultTheme
enum<string> | null
Available options:
light,
dark,
system
supportedLocales
string[] | null
Locales the site serves, which is what its hreflang alternates and sitemap.xml advertise. Organization-level - see PATCH /v1/platform/website.
defaultLocale
string | null
Locale served at the site root. Organization-level.
seoSettings
object
Site-wide SEO defaults. Each field is a fallback a page can override.
Show child attributes
pages
object[]
Present when fetching one website; omitted from the site list.
Show child attributes
layout
object
Header and footer, rendered on every page.
Show child attributes
hasCustomCss
boolean
updatedAt
string<date-time>
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"1club Help","colors":{"primary":"#471EFF","light":"#FFFFFF","dark":"#000000"},"logo":{"light":"https://mintcdn.com/1club/HM7mOd-FIJUyvW_1/logo/light.svg?fit=max\u0026auto=format\u0026n=HM7mOd-FIJUyvW_1\u0026q=85\u0026s=d93b7eb86d0fd304bfe27889e979db38","dark":"https://mintcdn.com/1club/HM7mOd-FIJUyvW_1/logo/dark.svg?fit=max\u0026auto=format\u0026n=HM7mOd-FIJUyvW_1\u0026q=85\u0026s=735ee613692e24e029e7d087b7effd44"},"favicon":"https://mintcdn.com/1club/iwVNuiPtdtxB6zsm/icon.png?fit=max\u0026auto=format\u0026n=iwVNuiPtdtxB6zsm\u0026q=85\u0026s=c8230ff0ac00066a07d7b0067f4c3df2","api":{"playground":{"display":"interactive","proxy":true}},"navbar":{"links":[{"href":"mailto:support@1club.ai","label":"Support"},{"href":"https://1club.ai","label":"Website"}],"primary":{"type":"button","label":"Log in","href":"https://admin.1club.ai"}},"footer":{"socials":{"x":"https://x.com/1club_ai","linkedin":"https://linkedin.com/company/1club_ai"}},"search":{"prompt":"Search the 1club help center"},"seo":{"metatags":{"og:type":"website","og:site_name":"1club Help","twitter:card":"summary_large_image"},"indexing":"all"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"1club","hasAudioNarration":false,"actualSubdomain":"1club","customDomains":["docs.1club.ai"],"gitSource":{"type":"github","owner":"1club-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6b005ca163690229f1b7e73f","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API","count":321},{"language":"default","tag":"Settings","count":124},{"language":"default","tag":"Guides","count":72},{"language":"default","tag":"Admin","count":64},{"language":"default","tag":"Staff Roster","count":24},{"language":"default","tag":"Sales","count":22},{"language":"default","tag":"Website","count":22},{"language":"default","tag":"Classes","count":20},{"language":"default","tag":"Events","count":15},{"language":"default","tag":"Members","count":15}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles/launches.css","content":".lx{--lx-accent: #471eff;--lx-accent-soft: rgba(71, 30, 255, 0.08);--lx-ink: #0f0f14;--lx-muted: #5c5c6b;--lx-line: rgba(15, 15, 20, 0.08);--lx-surface: #ffffff;--lx-sand: #f7f1ec;--lx-shadow: 0 1px 2px rgba(15, 15, 20, 0.04), 0 12px 32px -12px rgba(15, 15, 20, 0.12);color:var(--lx-ink)}.dark .lx{--lx-accent: #8f7bff;--lx-accent-soft: rgba(143, 123, 255, 0.12);--lx-ink: #f4f4f7;--lx-muted: #a3a3b2;--lx-line: rgba(255, 255, 255, 0.1);--lx-surface: #121218;--lx-sand: #17161d;--lx-shadow: 0 1px 2px rgba(0, 0, 0, 0.4), 0 12px 32px -12px rgba(0, 0, 0, 0.6)}.lx a{text-decoration:none;border:0}.lx-shot{display:block;width:100%;height:auto;aspect-ratio:16 / 10;object-fit:cover;margin:0}.lx-eyebrow{margin:0 0 12px;font-size:13px;font-weight:600;letter-spacing:0.08em;text-transform:uppercase;color:var(--lx-accent)}.lx-meta{display:inline-flex;align-items:center;gap:10px;margin:0;font-size:13px;color:var(--lx-muted)}.lx-badge{display:inline-flex;align-items:center;gap:6px;padding:3px 10px;border-radius:999px;font-size:12px;font-weight:600;letter-spacing:0.02em;color:#fff;background:var(--lx-accent)}.lx-badge::before{content:'';width:6px;height:6px;border-radius:999px;background:currentColor;opacity:0.85}.lx-link{font-size:14px;font-weight:600;color:var(--lx-accent)}.lx-link::after{content:' \\2192';transition:margin 0.15s ease}.lx-actions{display:flex;flex-wrap:wrap;gap:10px}.lx-btn{display:inline-flex;align-items:center;justify-content:center;height:42px;padding:0 20px;border-radius:999px;font-size:15px;font-weight:600;transition:transform 0.15s ease, background 0.15s ease, box-shadow 0.15s ease}.lx-btn:hover{transform:translateY(-1px)}.lx-btn-primary{color:#fff!important;background:var(--lx-accent);box-shadow:0 6px 20px -8px var(--lx-accent)}.lx-btn-primary::after{content:'\\2192';margin-left:8px}.lx-btn-ghost{color:var(--lx-ink)!important;background:var(--lx-surface);box-shadow:inset 0 0 0 1px var(--lx-line)}.lx-btn-ghost:hover{background:var(--lx-accent-soft)}.lx-strip{margin:4px 0 40px}.lx-strip-grid{display:grid;grid-template-columns:repeat(3, 1fr);gap:12px}.lx-card{display:flex;flex-direction:column;overflow:hidden;border-radius:12px;background:var(--lx-surface);box-shadow:inset 0 0 0 1px var(--lx-line);transition:transform 0.2s ease, box-shadow 0.2s ease}.lx-card:hover{transform:translateY(-2px);box-shadow:inset 0 0 0 1px var(--lx-accent), var(--lx-shadow)}.lx-card-shot{display:block;background:var(--lx-sand);border-bottom:1px solid var(--lx-line)}.lx-card-body{display:flex;flex-direction:column;gap:4px;padding:10px 12px 12px}.lx-card .lx-meta{font-size:12px}.lx-card-title{font-size:14px;font-weight:600;line-height:1.35;color:var(--lx-ink)}.lx-entry{display:grid;grid-template-columns:168px 1fr;align-items:center;gap:16px;margin-top:8px;padding:10px;border-radius:14px;background:var(--lx-surface);box-shadow:inset 0 0 0 1px var(--lx-line);transition:box-shadow 0.2s ease}.lx-entry:hover{box-shadow:inset 0 0 0 1px var(--lx-accent), var(--lx-shadow)}.lx-entry:hover .lx-link::after{margin-left:4px}.lx-entry-shot{display:block;overflow:hidden;border-radius:8px;background:var(--lx-sand);box-shadow:inset 0 0 0 1px var(--lx-line)}.lx-entry-body{display:flex;flex-direction:column;align-items:flex-start;gap:6px;padding-right:8px}.lx-entry .lx-badge{padding:2px 8px;font-size:11px}.lx-entry-summary{font-size:14px;line-height:1.5;color:var(--lx-ink)}.lx-more{--lx-more-accent: #471eff;margin-top:4px}.dark .lx-more{--lx-more-accent: #8f7bff}.lx-more-body{margin-bottom:10px}.lx-more-body[hidden]{display:none}.lx-more-body [data-as=\"p\"]{display:block;margin:0 0 14px}.lx-more-body>:last-child{margin-bottom:0}.lx-more-toggle{display:inline-flex;align-items:center;gap:8px;padding:0;border:0;background:none;cursor:pointer;font:inherit;font-size:14px;font-weight:600;color:var(--lx-more-accent)}.lx-more-toggle::after{content:'';width:6px;height:6px;margin-bottom:3px;border-right:2px solid currentColor;border-bottom:2px solid currentColor;transform:rotate(45deg);transition:transform 0.15s ease, margin 0.15s ease}.lx-more-toggle[aria-expanded=\"true\"]::after{margin:3px 0 0;transform:rotate(-135deg)}.lx-more-toggle:hover{text-decoration:underline;text-underline-offset:3px}.lx-page{max-width:1120px;margin:0 auto;padding:32px 24px 96px}.lx-hero{position:relative;display:flex;flex-direction:column;align-items:center;text-align:center;padding:24px 0 0}.lx-back{align-self:flex-start;margin-bottom:40px;font-size:14px;font-weight:500;color:var(--lx-muted)!important}.lx-back::before{content:'\\2190 '}.lx-back:hover{color:var(--lx-ink)!important}.lx-title{max-width:820px;margin:20px 0 0;font-size:clamp(36px, 6vw, 60px);font-weight:700;line-height:1.05;letter-spacing:-0.03em;color:var(--lx-ink)}.lx-lead{max-width:640px;margin:20px 0 32px;font-size:clamp(17px, 2vw, 20px);line-height:1.55;color:var(--lx-muted)}.lx-hero .lx-actions{justify-content:center}.lx-hero-shot{width:100%;margin-top:56px;overflow:hidden;border-radius:24px;background:var(--lx-sand);box-shadow:inset 0 0 0 1px var(--lx-line), 0 40px 80px -40px rgba(71, 30, 255, 0.35), var(--lx-shadow)}.lx-h2{margin:0;font-size:clamp(26px, 3.2vw, 36px);font-weight:700;line-height:1.15;letter-spacing:-0.02em;color:var(--lx-ink)}.lx-highlights{margin-top:96px;text-align:center}.lx-highlight-grid{display:grid;grid-template-columns:repeat(auto-fit, minmax(220px, 1fr));gap:16px;margin-top:36px;text-align:left}.lx-highlight{margin:0;padding:22px 22px 22px 58px;position:relative;border-radius:16px;font-size:16px;line-height:1.5;color:var(--lx-ink);background:var(--lx-surface);box-shadow:inset 0 0 0 1px var(--lx-line)}.lx-highlight::before,.lx-checks li::before{content:'';position:absolute;width:22px;height:22px;border-radius:999px;background:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='white' stroke-width='3' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpath d='M5 12.5l4.5 4.5L19 7.5'/%3E%3C/svg%3E\") center / 12px no-repeat,\n var(--lx-accent)}.lx-highlight::before{top:23px;left:22px}.lx-features{display:flex;flex-direction:column;gap:112px;margin-top:112px}.lx-feature{display:grid;grid-template-columns:5fr 7fr;align-items:center;gap:64px}.lx-feature-flip .lx-feature-text{order:2}.lx-num{display:block;margin-bottom:14px;font-size:14px;font-weight:600;font-variant-numeric:tabular-nums;color:var(--lx-accent)}.lx-checks{display:flex;flex-direction:column;gap:14px;margin:28px 0 0;padding:0;list-style:none}.lx-checks li{position:relative;margin:0;padding-left:36px;font-size:17px;line-height:1.5;color:var(--lx-muted)}.lx-checks li::before{top:1px;left:0}.lx-feature-shot{overflow:hidden;border-radius:20px;background:var(--lx-sand);box-shadow:inset 0 0 0 1px var(--lx-line), var(--lx-shadow)}.lx-details{max-width:720px;margin:128px auto 0}.lx-prose{max-width:none;margin-top:20px;font-size:17px;line-height:1.7}.lx-cta{margin-top:128px;padding:64px 32px;border-radius:28px;text-align:center;background:radial-gradient(70% 90% at 50% 0%, var(--lx-accent-soft), transparent 70%),\n var(--lx-sand);box-shadow:inset 0 0 0 1px var(--lx-line)}.lx-cta-title{max-width:720px;margin:0 auto 32px;font-size:clamp(28px, 4vw, 44px);font-weight:700;line-height:1.1;letter-spacing:-0.025em;color:var(--lx-ink)}.lx-cta .lx-actions{justify-content:center}@media (max-width: 768px){.lx-feature{grid-template-columns:1fr}.lx-strip-grid{grid-template-columns:1fr}.lx-card{flex-direction:row;align-items:center}.lx-card-shot{flex:0 0 120px;border-bottom:0;border-right:1px solid var(--lx-line)}.lx-entry{grid-template-columns:112px 1fr;gap:12px}.lx-feature{gap:28px}.lx-feature-flip .lx-feature-text{order:0}.lx-features{gap:72px;margin-top:72px}.lx-highlights,.lx-details,.lx-cta{margin-top:72px}.lx-hero-shot{margin-top:40px;border-radius:16px}.lx-back{margin-bottom:24px}}"}]}
{"page":{"pagePath":"api-reference/website/update-website-level-settings","slug":"/api-reference/website/update-website-level-settings","pageMetadata":{"title":"Update website-level settings","description":"Changes the website's name, theme behaviour and site-wide SEO defaults. Every field is optional; omitted fields are left alone.\n`supportedLocales` and `defaultLocale` are **organization-level** and need the additional `organization:write` scope. They also decide which languages the member portal, the mobile app and outbound email offer, and they take effect immediately rather than on publish - so they are a separate grant from editing the draft. They are reachable here at all because they are what decides which localized URLs the website serves: a page or section translated into an unlisted locale has no URL to be served at and no `hreflang` alternate pointing to it. A `defaultLocale` outside `supportedLocales` is a 400.\nEverything else in this body edits the **draft**, `seoSettings` included - it is stored in the site's settings, so a release carries it and the public site keeps serving the previously published values until you publish.\nDeliberately cannot change the site's address (`slug`, `domain`), which website is the organization's default, or whether the site is switched on - those move a customer's public presence and are not side effects a content edit should have.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/website","href":"/api-reference/website/update-website-level-settings","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Changes the website’s name, theme behaviour and site-wide SEO defaults. Every field is optional; omitted fields are left alone.\\n\", _jsx(_components.code, {\n children: \"supportedLocales\"\n }), \" and \", _jsx(_components.code, {\n children: \"defaultLocale\"\n }), \" are \", _jsx(_components.strong, {\n children: \"organization-level\"\n }), \" and need the additional \", _jsx(_components.code, {\n children: \"organization:write\"\n }), \" scope. They also decide which languages the member portal, the mobile app and outbound email offer, and they take effect immediately rather than on publish - so they are a separate grant from editing the draft. They are reachable here at all because they are what decides which localized URLs the website serves: a page or section translated into an unlisted locale has no URL to be served at and no \", _jsx(_components.code, {\n children: \"hreflang\"\n }), \" alternate pointing to it. A \", _jsx(_components.code, {\n children: \"defaultLocale\"\n }), \" outside \", _jsx(_components.code, {\n children: \"supportedLocales\"\n }), \" is a 400.\\nEverything else in this body edits the \", _jsx(_components.strong, {\n children: \"draft\"\n }), \", \", _jsx(_components.code, {\n children: \"seoSettings\"\n }), \" included - it is stored in the site’s settings, so a release carries it and the public site keeps serving the previously published values until you publish.\\nDeliberately cannot change the site’s address (\", _jsx(_components.code, {\n children: \"slug\"\n }), \", \", _jsx(_components.code, {\n children: \"domain\"\n }), \"), which website is the organization’s default, or whether the site is switched on - those move a customer’s public presence and are not side effects a content edit should have.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update website-level settings","description":"Changes the website's name, theme behaviour and site-wide SEO defaults. Every field is optional; omitted fields are left alone.\n`supportedLocales` and `defaultLocale` are **organization-level** and need the additional `organization:write` scope. They also decide which languages the member portal, the mobile app and outbound email offer, and they take effect immediately rather than on publish - so they are a separate grant from editing the draft. They are reachable here at all because they are what decides which localized URLs the website serves: a page or section translated into an unlisted locale has no URL to be served at and no `hreflang` alternate pointing to it. A `defaultLocale` outside `supportedLocales` is a 400.\nEverything else in this body edits the **draft**, `seoSettings` included - it is stored in the site's settings, so a release carries it and the public site keeps serving the previously published values until you publish.\nDeliberately cannot change the site's address (`slug`, `domain`), which website is the organization's default, or whether the site is switched on - those move a customer's public presence and are not side effects a content edit should have.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/website","href":"/api-reference/website/update-website-level-settings","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateWebsite","summary":"Update website-level settings","description":"Changes the website's name, theme behaviour and site-wide SEO defaults. Every field is optional; omitted fields are left alone.\n`supportedLocales` and `defaultLocale` are **organization-level** and need the additional `organization:write` scope. They also decide which languages the member portal, the mobile app and outbound email offer, and they take effect immediately rather than on publish - so they are a separate grant from editing the draft. They are reachable here at all because they are what decides which localized URLs the website serves: a page or section translated into an unlisted locale has no URL to be served at and no `hreflang` alternate pointing to it. A `defaultLocale` outside `supportedLocales` is a 400.\nEverything else in this body edits the **draft**, `seoSettings` included - it is stored in the site's settings, so a release carries it and the public site keeps serving the previously published values until you publish.\nDeliberately cannot change the site's address (`slug`, `domain`), which website is the organization's default, or whether the site is switched on - those move a customer's public presence and are not side effects a content edit should have.\n","tags":["Website"],"security":["09eb39a7-6284-4796-9f75-24721a2f52ad"],"parameters":["ac47f380-c2fa-49e8-b0cc-762a6b461003"],"requestBody":"1685a5fc-5aa2-44e8-8242-a86cff28d0ad","responses":{"200":"948a0e0d-bb6c-42ab-92be-ba2afd5a1c62","400":"599b9808-e16f-46d7-a075-2c1bae4afb2c","401":"0e0734c9-ef8e-4dc1-aaf1-afa459c07c80","403":"2c47932a-ab05-40f0-af0a-894477f9b9f9","429":"1ffe273b-e357-479d-bb2a-38c57e1501f6"},"method":"patch","type":"path","servers":["271bc9cb-062d-498d-90b7-92302d2b0c58"],"path":"/v1/platform/website","baseUrlOptions":["https://api.1club.ai"],"title":"Update website-level settings","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ac47f380-c2fa-49e8-b0cc-762a6b461003":{"in":"query","name":"siteId","schema":{"type":"integer","uniqueKey":"","typeLabel":"integer"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"themeSupport":{"type":"string","enum":["both","light","dark"],"description":"`both` lets a visitor switch; `light`/`dark` fixes the theme.","uniqueKey":"themeSupport","typeLabel":"enum\u003cstring>"},"defaultTheme":{"type":"string","enum":["light","dark","system"],"description":"Only meaningful when themeSupport is `both`.","uniqueKey":"defaultTheme","typeLabel":"enum\u003cstring>"},"seoSettings":{"type":"object","description":"Site-wide SEO defaults, replacing the whole object - read the current one from `GET /website` first. Every field is a fallback a page can override.\n","additionalProperties":false,"properties":{"siteDescription":{"oneOf":[{"type":"string","description":"Meta description for pages that set none, and the `description` in the site's Organization / LocalBusiness / WebSite structured data.\n","uniqueKey":"seoSettings.siteDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"Meta description for pages that set none, and the `description` in the site's Organization / LocalBusiness / WebSite structured data.\n","uniqueKey":"seoSettings.siteDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"seoSettings.siteDescription","typeLabel":"string | null"},"defaultOgImage":{"oneOf":[{"type":"string","format":"uri","description":"Social-share image for pages with no `ogImage`. Get a URL from `GET /media`.","uniqueKey":"seoSettings.defaultOgImage.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Social-share image for pages with no `ogImage`. Get a URL from `GET /media`.","uniqueKey":"seoSettings.defaultOgImage.oneOf.1","typeLabel":"null"}],"uniqueKey":"seoSettings.defaultOgImage","typeLabel":"string\u003curi> | null"},"verification":{"oneOf":[{"type":"object","additionalProperties":false,"description":"Search-console ownership tokens, rendered as meta tags on every page.","properties":{"google":{"oneOf":[{"type":"string","description":"Google Search Console token","uniqueKey":"seoSettings.verification.oneOf.0.google.oneOf.0","typeLabel":"string"},{"type":"null","description":"Google Search Console token","uniqueKey":"seoSettings.verification.oneOf.0.google.oneOf.1","typeLabel":"null"}],"uniqueKey":"seoSettings.verification.oneOf.0.google","typeLabel":"string | null"},"bing":{"oneOf":[{"type":"string","description":"Bing Webmaster Tools token","uniqueKey":"seoSettings.verification.oneOf.0.bing.oneOf.0","typeLabel":"string"},{"type":"null","description":"Bing Webmaster Tools token","uniqueKey":"seoSettings.verification.oneOf.0.bing.oneOf.1","typeLabel":"null"}],"uniqueKey":"seoSettings.verification.oneOf.0.bing","typeLabel":"string | null"}},"uniqueKey":"seoSettings.verification.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"description":"Search-console ownership tokens, rendered as meta tags on every page.","properties":{"google":{"oneOf":[{"type":"string","description":"Google Search Console token"},{"type":"null","description":"Google Search Console token"}]},"bing":{"oneOf":[{"type":"string","description":"Bing Webmaster Tools token"},{"type":"null","description":"Bing Webmaster Tools token"}]}},"uniqueKey":"seoSettings.verification.oneOf.1","typeLabel":"null"}],"uniqueKey":"seoSettings.verification","typeLabel":"object | null"}},"uniqueKey":"seoSettings","typeLabel":"object"},"buttonStyle":{"type":"object","description":"How buttons look across the WHOLE website. Site-wide on purpose: a section chooses each button's emphasis (`primary`/`secondary`/`outline`/`ghost`), but a site with pill buttons in the hero and square ones in a CTA reads as broken. Unlike `seoSettings` this MERGES field by field, so setting the shape leaves the casing alone. An all-default style is stored as nothing, and the renderer falls back to `pill`.\n","additionalProperties":false,"properties":{"shape":{"type":"string","enum":["pill","rounded","square"],"description":"Corner treatment for every button. Defaults to `pill`.","uniqueKey":"buttonStyle.shape","typeLabel":"enum\u003cstring>"},"uppercase":{"type":"boolean","description":"Uppercase button labels, with a little letter-spacing so they stay readable.","uniqueKey":"buttonStyle.uppercase","typeLabel":"boolean"}},"uniqueKey":"buttonStyle","typeLabel":"object"},"cornerRadius":{"oneOf":[{"type":"string","enum":["sharp","soft","round"],"description":"How round every corner on the site is - section cards, media frames, form controls, and buttons on `sharp`/`round`. Defaults to `soft`, which is what every site rendered before this existed. `null` returns to the default.\n","uniqueKey":"cornerRadius.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["sharp","soft","round"],"description":"How round every corner on the site is - section cards, media frames, form controls, and buttons on `sharp`/`round`. Defaults to `soft`, which is what every site rendered before this existed. `null` returns to the default.\n","uniqueKey":"cornerRadius.oneOf.1","typeLabel":"null"}],"uniqueKey":"cornerRadius","typeLabel":"enum\u003cstring> | null"},"spacing":{"oneOf":[{"type":"string","enum":["compact","default","airy"],"description":"The site's baseline vertical rhythm: the gap BETWEEN sections and the default padding inside one. A section's own `paddingY` overrides the padding half; the gap is the part no per-section control reaches. `null` returns to the default.\n","uniqueKey":"spacing.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["compact","default","airy"],"description":"The site's baseline vertical rhythm: the gap BETWEEN sections and the default padding inside one. A section's own `paddingY` overrides the padding half; the gap is the part no per-section control reaches. `null` returns to the default.\n","uniqueKey":"spacing.oneOf.1","typeLabel":"null"}],"uniqueKey":"spacing","typeLabel":"enum\u003cstring> | null"},"typeScale":{"oneOf":[{"type":"string","enum":["compact","default","editorial"],"description":"How large headings run relative to body text. A multiplier on the heading ladder rather than a set of sizes. `null` returns to the default.\n","uniqueKey":"typeScale.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["compact","default","editorial"],"description":"How large headings run relative to body text. A multiplier on the heading ladder rather than a set of sizes. `null` returns to the default.\n","uniqueKey":"typeScale.oneOf.1","typeLabel":"null"}],"uniqueKey":"typeScale","typeLabel":"enum\u003cstring> | null"},"clubId":{"oneOf":[{"type":"integer","description":"Club this website represents. When set, the header and footer use that club's logo instead of the organization's. `null` clears the binding. Takes effect immediately, like `name` — logos are branding assets rather than a published token.\n","uniqueKey":"clubId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Club this website represents. When set, the header and footer use that club's logo instead of the organization's. `null` clears the binding. Takes effect immediately, like `name` — logos are branding assets rather than a published token.\n","uniqueKey":"clubId.oneOf.1","typeLabel":"null"}],"uniqueKey":"clubId","typeLabel":"integer | null"},"supportedLocales":{"type":"array","description":"Locales this organization serves, in display order. Organization-level, requires `organization:write`, and applies immediately - see the endpoint description. Must contain `defaultLocale`.\n","items":{"type":"string","enum":["en","es","fr","de","bg","cs"],"uniqueKey":"supportedLocales.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"supportedLocales","typeLabel":"enum\u003cstring>[]"},"defaultLocale":{"type":"string","enum":["en","es","fr","de","bg","cs"],"description":"Locale served at the site root. Organization-level, requires `organization:write`.","uniqueKey":"defaultLocale","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","seoSettings":{"siteDescription":"\u003cstring>","defaultOgImage":"\u003cstring>","verification":{"google":"\u003cstring>","bing":"\u003cstring>"}},"buttonStyle":{"uppercase":true},"clubId":123,"supportedLocales":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"948a0e0d-bb6c-42ab-92be-ba2afd5a1c62":{"description":"The updated website","content":{"application/json":{"schema":{"type":"object","description":"A website belonging to the organization. Page content, layout and theme tokens describe the **draft**. `url`, `published`, `activeReleaseVersion` and `lastPublishedAt` describe what the public is currently being served. `name` and `clubId` are live row fields — they take effect without a publish.","properties":{"id":{"type":"integer","uniqueKey":"id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"slug":{"type":"string","description":"Platform host label - the site answers on `\u003cslug>.1club.me`.","uniqueKey":"slug","typeLabel":"string"},"domain":{"oneOf":[{"type":"string","description":"Custom domain, when one is pointed at this site.","uniqueKey":"domain.oneOf.0","typeLabel":"string"},{"type":"null","description":"Custom domain, when one is pointed at this site.","uniqueKey":"domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"domain","typeLabel":"string | null"},"isDefault":{"type":"boolean","description":"True for the site an organization-wide caller means by \"the website\". Exactly one per organization.","uniqueKey":"isDefault","typeLabel":"boolean"},"isActive":{"type":"boolean","description":"False means the site is switched off and serves nothing publicly, whatever the draft contains.","uniqueKey":"isActive","typeLabel":"boolean"},"clubId":{"oneOf":[{"type":"integer","description":"Club this website represents. When set, the header and footer use that club's logo instead of the organization's. Live, like `name`.","uniqueKey":"clubId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Club this website represents. When set, the header and footer use that club's logo instead of the organization's. Live, like `name`.","uniqueKey":"clubId.oneOf.1","typeLabel":"null"}],"uniqueKey":"clubId","typeLabel":"integer | null"},"url":{"type":"string","description":"Public URL - the custom domain when set, else the platform host.","uniqueKey":"url","typeLabel":"string"},"previewUrl":{"type":"string","description":"The same site rendered from the unpublished draft - the link to review edits before publishing. Carries a signed grant that expires 24 hours after this response was generated; read the website again for a fresh one. Anyone holding the link can view the draft, so it is shareable without a login but should be treated as sensitive.","uniqueKey":"previewUrl","typeLabel":"string"},"published":{"type":"boolean","description":"Whether the site has ever been published. False means nothing is publicly reachable yet.","uniqueKey":"published","typeLabel":"boolean"},"activeReleaseVersion":{"oneOf":[{"type":"integer","uniqueKey":"activeReleaseVersion.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"activeReleaseVersion.oneOf.1","typeLabel":"null"}],"uniqueKey":"activeReleaseVersion","typeLabel":"integer | null"},"lastPublishedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"lastPublishedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"lastPublishedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"lastPublishedAt","typeLabel":"string\u003cdate-time> | null"},"themeSupport":{"oneOf":[{"type":"string","enum":["both","light","dark"],"uniqueKey":"themeSupport.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["both","light","dark"],"uniqueKey":"themeSupport.oneOf.1","typeLabel":"null"}],"uniqueKey":"themeSupport","typeLabel":"enum\u003cstring> | null"},"defaultTheme":{"oneOf":[{"type":"string","enum":["light","dark","system"],"uniqueKey":"defaultTheme.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["light","dark","system"],"uniqueKey":"defaultTheme.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultTheme","typeLabel":"enum\u003cstring> | null"},"supportedLocales":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"supportedLocales.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Locales the site serves, which is what its `hreflang` alternates and `sitemap.xml` advertise. Organization-level - see `PATCH /v1/platform/website`.","uniqueKey":"supportedLocales.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Locales the site serves, which is what its `hreflang` alternates and `sitemap.xml` advertise. Organization-level - see `PATCH /v1/platform/website`.","uniqueKey":"supportedLocales.oneOf.1","typeLabel":"null"}],"uniqueKey":"supportedLocales","typeLabel":"string[] | null"},"defaultLocale":{"oneOf":[{"type":"string","description":"Locale served at the site root. Organization-level.","uniqueKey":"defaultLocale.oneOf.0","typeLabel":"string"},{"type":"null","description":"Locale served at the site root. Organization-level.","uniqueKey":"defaultLocale.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultLocale","typeLabel":"string | null"},"seoSettings":{"type":"object","description":"Site-wide SEO defaults. Each field is a fallback a page can override.","additionalProperties":false,"properties":{"siteDescription":{"type":"string","description":"Meta-description fallback, and the `description` in the site's structured data.","uniqueKey":"seoSettings.siteDescription","typeLabel":"string"},"defaultOgImage":{"type":"string","description":"Social-share image for pages with no `ogImage` of their own.","uniqueKey":"seoSettings.defaultOgImage","typeLabel":"string"},"verification":{"type":"object","description":"Search-console ownership tokens, rendered as meta tags on every page.","properties":{"google":{"type":"string","uniqueKey":"seoSettings.verification.google","typeLabel":"string"},"bing":{"type":"string","uniqueKey":"seoSettings.verification.bing","typeLabel":"string"}},"uniqueKey":"seoSettings.verification","typeLabel":"object"}},"uniqueKey":"seoSettings","typeLabel":"object"},"pages":{"type":"array","description":"Present when fetching one website; omitted from the site list.","items":{"type":"object","description":"A page on the website draft.","properties":{"slug":{"type":"string","description":"URL path segment. The homepage is served at \"/\" regardless of its slug.","uniqueKey":"pages.items.[INDEX].slug","typeLabel":"string"},"title":{"type":"string","uniqueKey":"pages.items.[INDEX].title","typeLabel":"string"},"isHomepage":{"type":"boolean","uniqueKey":"pages.items.[INDEX].isHomepage","typeLabel":"boolean"},"sectionCount":{"type":"integer","uniqueKey":"pages.items.[INDEX].sectionCount","typeLabel":"integer"},"sectionTypes":{"type":"array","items":{"type":"string","uniqueKey":"pages.items.[INDEX].sectionTypes.items.[INDEX]","typeLabel":"string"},"uniqueKey":"pages.items.[INDEX].sectionTypes","typeLabel":"string[]"},"sections":{"type":"array","description":"Present when fetching a single page; omitted from list responses.","items":{"type":"object","description":"One section of a page or of the site layout. `config` fields depend on `type` - see GET /v1/platform/website/section-types for the definitions.","properties":{"type":{"type":"string","description":"Section type, e.g. \"hero\", \"plans\", \"faq\", \"header\".","uniqueKey":"pages.items.[INDEX].sections.items.[INDEX].type","typeLabel":"string"},"htmlId":{"type":"string","pattern":"^[a-z][a-z0-9-]*$","description":"The section's anchor on the page (`#\u003chtmlId>`), unique within the page. Send back the value a read returned to keep it; omit it and one is derived from the type.","uniqueKey":"pages.items.[INDEX].sections.items.[INDEX].htmlId","typeLabel":"string"},"config":{"type":"object","additionalProperties":true,"uniqueKey":"pages.items.[INDEX].sections.items.[INDEX].config","typeLabel":"object"},"translations":{"type":"object","additionalProperties":true,"description":"Per-locale overrides for the section's translatable string fields, keyed by locale then field: { \"bg\": { \"headline\": \"…\" } }. Config values themselves stay in the default language.","uniqueKey":"pages.items.[INDEX].sections.items.[INDEX].translations","typeLabel":"object"}},"uniqueKey":"pages.items.[INDEX].sections.items.[INDEX]","typeLabel":"object"},"uniqueKey":"pages.items.[INDEX].sections","typeLabel":"object[]"},"metaTitle":{"oneOf":[{"type":"string","uniqueKey":"pages.items.[INDEX].metaTitle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"pages.items.[INDEX].metaTitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"pages.items.[INDEX].metaTitle","typeLabel":"string | null"},"metaDescription":{"oneOf":[{"type":"string","uniqueKey":"pages.items.[INDEX].metaDescription.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"pages.items.[INDEX].metaDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"pages.items.[INDEX].metaDescription","typeLabel":"string | null"},"ogImage":{"oneOf":[{"type":"string","uniqueKey":"pages.items.[INDEX].ogImage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"pages.items.[INDEX].ogImage.oneOf.1","typeLabel":"null"}],"uniqueKey":"pages.items.[INDEX].ogImage","typeLabel":"string | null"},"noindex":{"type":"boolean","description":"True when the page asks search engines not to index it and is left out of `sitemap.xml`.","uniqueKey":"pages.items.[INDEX].noindex","typeLabel":"boolean"},"translations":{"oneOf":[{"type":"object","description":"Per-locale `metaTitle`/`metaDescription` overrides, keyed by locale: { \"bg\": { \"metaTitle\": \"…\" } }. Present when fetching a single page.","additionalProperties":{"type":"object","properties":{"metaTitle":{"type":"string","uniqueKey":"pages.items.[INDEX].translations.oneOf.0.additionalProperties.metaTitle","typeLabel":"string"},"metaDescription":{"type":"string","uniqueKey":"pages.items.[INDEX].translations.oneOf.0.additionalProperties.metaDescription","typeLabel":"string"}},"uniqueKey":"pages.items.[INDEX].translations.oneOf.0.additionalProperties","typeLabel":"object"},"uniqueKey":"pages.items.[INDEX].translations.oneOf.0","typeLabel":"object"},{"type":"null","description":"Per-locale `metaTitle`/`metaDescription` overrides, keyed by locale: { \"bg\": { \"metaTitle\": \"…\" } }. Present when fetching a single page.","additionalProperties":{"type":"object","properties":{"metaTitle":{"type":"string","uniqueKey":"pages.items.[INDEX].translations.oneOf.1.additionalProperties.metaTitle","typeLabel":"string"},"metaDescription":{"type":"string","uniqueKey":"pages.items.[INDEX].translations.oneOf.1.additionalProperties.metaDescription","typeLabel":"string"}},"uniqueKey":"pages.items.[INDEX].translations.oneOf.1.additionalProperties","typeLabel":"object"},"uniqueKey":"pages.items.[INDEX].translations.oneOf.1","typeLabel":"null"}],"uniqueKey":"pages.items.[INDEX].translations","typeLabel":"object | null"},"seo":{"type":"object","description":"What the published page will actually put in its `\u003chead>`, after every fallback has been applied - the authored fields alone do not answer \"is my SEO right?\". Present when fetching a single page. Read-only.","properties":{"metaTitle":{"type":"string","description":"The `\u003ctitle>`, after falling back to the page title.","uniqueKey":"pages.items.[INDEX].seo.metaTitle","typeLabel":"string"},"metaDescription":{"oneOf":[{"type":"string","description":"After falling back to `seoSettings.siteDescription`.","uniqueKey":"pages.items.[INDEX].seo.metaDescription.oneOf.0","typeLabel":"string"},{"type":"null","description":"After falling back to `seoSettings.siteDescription`.","uniqueKey":"pages.items.[INDEX].seo.metaDescription.oneOf.1","typeLabel":"null"}],"uniqueKey":"pages.items.[INDEX].seo.metaDescription","typeLabel":"string | null"},"ogImage":{"oneOf":[{"type":"string","description":"After falling back to `seoSettings.defaultOgImage`.","uniqueKey":"pages.items.[INDEX].seo.ogImage.oneOf.0","typeLabel":"string"},{"type":"null","description":"After falling back to `seoSettings.defaultOgImage`.","uniqueKey":"pages.items.[INDEX].seo.ogImage.oneOf.1","typeLabel":"null"}],"uniqueKey":"pages.items.[INDEX].seo.ogImage","typeLabel":"string | null"},"canonicalUrl":{"type":"string","description":"The `rel=canonical` the default-locale render emits, locale prefix included.","uniqueKey":"pages.items.[INDEX].seo.canonicalUrl","typeLabel":"string"},"indexable":{"type":"boolean","description":"Whether search engines are asked to index this page.","uniqueKey":"pages.items.[INDEX].seo.indexable","typeLabel":"boolean"},"notIndexableReason":{"oneOf":[{"type":"string","enum":["page_noindex","site_unpublished","site_inactive"],"description":"Why `indexable` is false. An unpublished or switched-off site is not indexable however the page is configured.","uniqueKey":"pages.items.[INDEX].seo.notIndexableReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["page_noindex","site_unpublished","site_inactive"],"description":"Why `indexable` is false. An unpublished or switched-off site is not indexable however the page is configured.","uniqueKey":"pages.items.[INDEX].seo.notIndexableReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"pages.items.[INDEX].seo.notIndexableReason","typeLabel":"enum\u003cstring> | null"},"localizedLocales":{"type":"array","items":{"type":"string","uniqueKey":"pages.items.[INDEX].seo.localizedLocales.items.[INDEX]","typeLabel":"string"},"description":"Locales carrying their own metaTitle/metaDescription overrides.","uniqueKey":"pages.items.[INDEX].seo.localizedLocales","typeLabel":"string[]"}},"uniqueKey":"pages.items.[INDEX].seo","typeLabel":"object"},"url":{"type":"string","description":"The page's public URL once published.","uniqueKey":"pages.items.[INDEX].url","typeLabel":"string"}},"uniqueKey":"pages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"pages","typeLabel":"object[]"},"layout":{"type":"object","description":"Header and footer, rendered on every page.","properties":{"header":{"type":"object","description":"One section of a page or of the site layout. `config` fields depend on `type` - see GET /v1/platform/website/section-types for the definitions.","properties":{"type":{"type":"string","description":"Section type, e.g. \"hero\", \"plans\", \"faq\", \"header\".","uniqueKey":"layout.header.type","typeLabel":"string"},"htmlId":{"type":"string","pattern":"^[a-z][a-z0-9-]*$","description":"The section's anchor on the page (`#\u003chtmlId>`), unique within the page. Send back the value a read returned to keep it; omit it and one is derived from the type.","uniqueKey":"layout.header.htmlId","typeLabel":"string"},"config":{"type":"object","additionalProperties":true,"uniqueKey":"layout.header.config","typeLabel":"object"},"translations":{"type":"object","additionalProperties":true,"description":"Per-locale overrides for the section's translatable string fields, keyed by locale then field: { \"bg\": { \"headline\": \"…\" } }. Config values themselves stay in the default language.","uniqueKey":"layout.header.translations","typeLabel":"object"}},"uniqueKey":"layout.header","typeLabel":"object"},"footer":{"type":"object","description":"One section of a page or of the site layout. `config` fields depend on `type` - see GET /v1/platform/website/section-types for the definitions.","properties":{"type":{"type":"string","description":"Section type, e.g. \"hero\", \"plans\", \"faq\", \"header\".","uniqueKey":"layout.footer.type","typeLabel":"string"},"htmlId":{"type":"string","pattern":"^[a-z][a-z0-9-]*$","description":"The section's anchor on the page (`#\u003chtmlId>`), unique within the page. Send back the value a read returned to keep it; omit it and one is derived from the type.","uniqueKey":"layout.footer.htmlId","typeLabel":"string"},"config":{"type":"object","additionalProperties":true,"uniqueKey":"layout.footer.config","typeLabel":"object"},"translations":{"type":"object","additionalProperties":true,"description":"Per-locale overrides for the section's translatable string fields, keyed by locale then field: { \"bg\": { \"headline\": \"…\" } }. Config values themselves stay in the default language.","uniqueKey":"layout.footer.translations","typeLabel":"object"}},"uniqueKey":"layout.footer","typeLabel":"object"}},"uniqueKey":"layout","typeLabel":"object"},"hasCustomCss":{"type":"boolean","uniqueKey":"hasCustomCss","typeLabel":"boolean"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"name":"\u003cstring>","slug":"\u003cstring>","domain":"\u003cstring>","isDefault":true,"isActive":true,"clubId":123,"url":"\u003cstring>","previewUrl":"\u003cstring>","published":true,"activeReleaseVersion":123,"lastPublishedAt":"2023-11-07T05:31:56Z","themeSupport":"both","defaultTheme":"light","supportedLocales":["\u003cstring>"],"defaultLocale":"\u003cstring>","seoSettings":{"siteDescription":"\u003cstring>","defaultOgImage":"\u003cstring>","verification":{"google":"\u003cstring>","bing":"\u003cstring>"}},"pages":[{"slug":"\u003cstring>","title":"\u003cstring>","isHomepage":true,"sectionCount":123,"sectionTypes":["\u003cstring>"],"sections":[{"type":"\u003cstring>","htmlId":"\u003cstring>","config":{},"translations":{}}],"metaTitle":"\u003cstring>","metaDescription":"\u003cstring>","ogImage":"\u003cstring>","noindex":true,"translations":{},"seo":{"metaTitle":"\u003cstring>","metaDescription":"\u003cstring>","ogImage":"\u003cstring>","canonicalUrl":"\u003cstring>","indexable":true,"notIndexableReason":"page_noindex","localizedLocales":["\u003cstring>"]},"url":"\u003cstring>"}],"layout":{"header":{"type":"\u003cstring>","htmlId":"\u003cstring>","config":{},"translations":{}},"footer":{"type":"\u003cstring>","htmlId":"\u003cstring>","config":{},"translations":{}}},"hasCustomCss":true,"updatedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"599b9808-e16f-46d7-a075-2c1bae4afb2c":{"description":"Invalid body","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"0e0734c9-ef8e-4dc1-aaf1-afa459c07c80":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"2c47932a-ab05-40f0-af0a-894477f9b9f9":{"description":"API key is missing `website:write`, or `organization:write` when the body carries locale fields","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"1ffe273b-e357-479d-bb2a-38c57e1501f6":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"09eb39a7-6284-4796-9f75-24721a2f52ad":{"customerApiAuth":{"type":"http","scheme":"bearer","description":"Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.","scopes":[],"schemeName":"customerApiAuth"}}},"servers":{"271bc9cb-062d-498d-90b7-92302d2b0c58":{"url":"https://api.1club.ai","description":"Production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.","scopes":[],"schemeName":"customerApiAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"customerApiAuth","name":"Authorization"}],"title":"customerApiAuth"}]},"originalFileLocation":"openapi-platform.json"},"subdomain":"1club","siteName":"1club Help","title":"Update website-level settings - 1club Help","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T14:43:57.539Z","originalFileLocation":"api-reference/website/update-website-level-settings.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Changes the website\u0026#x27;s name, theme behaviour and site-wide SEO defaults. Every field is optional; omitted fields are left alone. supportedLocales and defaultLocale are organization-level and need the additional organization:write scope. They also decide which languages the member portal, the mobile app and outbound email offer, and they take effect immediately rather than on publish - so they are a separate grant from editing the draft. They are reachable here at all because they are what decides which localized URLs the website serves: a page or section translated into an unlisted locale has no URL to be served at and no hreflang alternate pointing to it. A defaultLocale outside supportedLocales is a 400. Everything else in this body edits the draft, seoSettings included - it is stored in the site\u0026#x27;s settings, so a release carries it and the public site keeps serving the previously published values until you publish. Deliberately cannot change the site\u0026#x27;s address (slug, domain), which website is the organization\u0026#x27;s default, or whether the site is switched on - those move a customer\u0026#x27;s public presence and are not side effects a content edit should have.\">\u003cmeta data-mint-head name=\"application-name\" content=\"1club Help\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update website-level settings - 1club Help\">\u003cmeta data-mint-head property=\"og:description\" content=\"Changes the website\u0026#x27;s name, theme behaviour and site-wide SEO defaults. Every field is optional; omitted fields are left alone. supportedLocales and defaultLocale are organization-level and need the additional organization:write scope. They also decide which languages the member portal, the mobile app and outbound email offer, and they take effect immediately rather than on publish - so they are a separate grant from editing the draft. They are reachable here at all because they are what decides which localized URLs the website serves: a page or section translated into an unlisted locale has no URL to be served at and no hreflang alternate pointing to it. A defaultLocale outside supportedLocales is a 400. Everything else in this body edits the draft, seoSettings included - it is stored in the site\u0026#x27;s settings, so a release carries it and the public site keeps serving the previously published values until you publish. Deliberately cannot change the site\u0026#x27;s address (slug, domain), which website is the organization\u0026#x27;s default, or whether the site is switched on - those move a customer\u0026#x27;s public presence and are not side effects a content edit should have.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"1club Help\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.1club.ai/api-reference/website/update-website-level-settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://1club.mintlify.site/_mintlify/api/og/v2?division=Website\u0026amp;title=Update+website-level+settings\u0026amp;description=Changes+the+website%27s+name%2C+theme+behaviour+and+site-wide+SEO+defaults.+Every+field+is+optional%3B+omitted+fields+are+left+alone.%0A%60supportedLocales%60+and+%60defaultL\u0026amp;theme=ed3cd824c84f0d7b56c4d20a\u0026amp;signature=17cf7c68041c237f3bf94dc08a97ca3ef4e972981e06b2db01715e3b2109ffc3\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update website-level settings - 1club Help\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Changes the website\u0026#x27;s name, theme behaviour and site-wide SEO defaults. Every field is optional; omitted fields are left alone. supportedLocales and defaultLocale are organization-level and need the additional organization:write scope. They also decide which languages the member portal, the mobile app and outbound email offer, and they take effect immediately rather than on publish - so they are a separate grant from editing the draft. They are reachable here at all because they are what decides which localized URLs the website serves: a page or section translated into an unlisted locale has no URL to be served at and no hreflang alternate pointing to it. A defaultLocale outside supportedLocales is a 400. Everything else in this body edits the draft, seoSettings included - it is stored in the site\u0026#x27;s settings, so a release carries it and the public site keeps serving the previously published values until you publish. Deliberately cannot change the site\u0026#x27;s address (slug, domain), which website is the organization\u0026#x27;s default, or whether the site is switched on - those move a customer\u0026#x27;s public presence and are not side effects a content edit should have.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://1club.mintlify.site/_mintlify/api/og/v2?division=Website\u0026amp;title=Update+website-level+settings\u0026amp;description=Changes+the+website%27s+name%2C+theme+behaviour+and+site-wide+SEO+defaults.+Every+field+is+optional%3B+omitted+fields+are+left+alone.%0A%60supportedLocales%60+and+%60defaultL\u0026amp;theme=ed3cd824c84f0d7b56c4d20a\u0026amp;signature=17cf7c68041c237f3bf94dc08a97ca3ef4e972981e06b2db01715e3b2109ffc3\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/1club/s8VCyK5jYOjTojj3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"1club Help\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#471EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.1club.ai/api-reference/website/update-website-level-settings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/website/update-website-level-settings.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.1club.ai/#organization\",\"name\":\"1club Help\",\"url\":\"https://docs.1club.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/1club/HM7mOd-FIJUyvW_1/logo/light.svg?fit=max\u0026auto=format\u0026n=HM7mOd-FIJUyvW_1\u0026q=85\u0026s=d93b7eb86d0fd304bfe27889e979db38\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.1club.ai#website\",\"name\":\"1club Help\",\"url\":\"https://docs.1club.ai\",\"publisher\":{\"@id\":\"https://docs.1club.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.1club.ai/api-reference/website/update-website-level-settings#webpage\",\"url\":\"https://docs.1club.ai/api-reference/website/update-website-level-settings\",\"name\":\"Update website-level settings\",\"description\":\"Changes the website's name, theme behaviour and site-wide SEO defaults. Every field is optional; omitted fields are left alone. supportedLocales and defaultLocale are organization-level and need the additional organization:write scope. They also decide which languages the member portal, the mobile app and outbound email offer, and they take effect immediately rather than on publish - so they are a separate grant from editing the draft. They are reachable here at all because they are what decides which localized URLs the website serves: a page or section translated into an unlisted locale has no URL to be served at and no hreflang alternate pointing to it. A defaultLocale outside supportedLocales is a 400. Everything else in this body edits the draft, seoSettings included - it is stored in the site's settings, so a release carries it and the public site keeps serving the previously published values until you publish. Deliberately cannot change the site's address (slug, domain), which website is the organization's default, or whether the site is switched on - those move a customer's public presence and are not side effects a content edit should have.\",\"dateModified\":\"2026-11-20T14:43:57.539Z\",\"isPartOf\":{\"@id\":\"https://docs.1club.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.1club.ai/api-reference/website/update-website-level-settings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.1club.ai/api-reference/website/update-website-level-settings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Website\",\"item\":\"https://docs.1club.ai/api-reference/website/get-the-website\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update website-level settings\",\"item\":\"https://docs.1club.ai/api-reference/website/update-website-level-settings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.1club.ai/api-reference/website/update-website-level-settings#apireference\",\"headline\":\"Update website-level settings\",\"name\":\"Update website-level settings\",\"description\":\"Changes the website's name, theme behaviour and site-wide SEO defaults. Every field is optional; omitted fields are left alone. supportedLocales and defaultLocale are organization-level and need the additional organization:write scope. They also decide which languages the member portal, the mobile app and outbound email offer, and they take effect immediately rather than on publish - so they are a separate grant from editing the draft. They are reachable here at all because they are what decides which localized URLs the website serves: a page or section translated into an unlisted locale has no URL to be served at and no hreflang alternate pointing to it. A defaultLocale outside supportedLocales is a 400. Everything else in this body edits the draft, seoSettings included - it is stored in the site's settings, so a release carries it and the public site keeps serving the previously published values until you publish. Deliberately cannot change the site's address (slug, domain), which website is the organization's default, or whether the site is switched on - those move a customer's public presence and are not side effects a content edit should have.\",\"url\":\"https://docs.1club.ai/api-reference/website/update-website-level-settings\",\"mainEntityOfPage\":{\"@id\":\"https://docs.1club.ai/api-reference/website/update-website-level-settings#webpage\"},\"dateModified\":\"2026-11-20T14:43:57.539Z\",\"publisher\":{\"@id\":\"https://docs.1club.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.1club.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"1club Help\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"1club Help\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/website/update-website-level-settings.md","siteName":"1club Help","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"Settings","icon":"gear","pages":[{"title":"Settings","href":"/settings/overview"}]},{"tab":"API","icon":"code","groups":[{"group":"Getting Started","pages":[{"title":"1club Platform API reference","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"1club network API","sidebarTitle":"Network API","href":"/api-reference/marketplace-api"},{"title":"Versioning and deprecation","href":"/api-reference/versioning"},{"title":"Report changes","href":"/api-reference/changes"}]},{"group":"Channel integration","pages":[{"title":"Channel integration overview","href":"/api-reference/channel-integration/overview"},{"title":"Authentication","href":"/api-reference/channel-integration/authentication"},{"title":"Areas and availability","href":"/api-reference/channel-integration/areas-and-availability"},{"title":"Contacts","href":"/api-reference/channel-integration/contacts"},{"title":"Instructors","href":"/api-reference/channel-integration/instructors"},{"title":"Classes","href":"/api-reference/channel-integration/classes"},{"title":"Plans","href":"/api-reference/channel-integration/plans"},{"title":"Memberships","href":"/api-reference/channel-integration/memberships"},{"title":"Products","href":"/api-reference/channel-integration/products"},{"title":"Bookings","href":"/api-reference/channel-integration/bookings"},{"title":"Check-ins","href":"/api-reference/channel-integration/checkins"},{"title":"Idempotency","href":"/api-reference/channel-integration/idempotency"},{"title":"Webhooks","href":"/api-reference/channel-integration/webhooks"}]},{"group":"Area Blocks","pages":[{"title":"List area blocks","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/area-blocks","href":"/api-reference/area-blocks/list-area-blocks"},{"title":"Create an area block","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/area-blocks","href":"/api-reference/area-blocks/create-an-area-block"},{"title":"Delete an area block","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/area-blocks/{blockId}","href":"/api-reference/area-blocks/delete-an-area-block"}]},{"group":"Areas","pages":[{"title":"List area types","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/area-types","href":"/api-reference/areas/list-area-types"},{"title":"Create an area type","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/area-types","href":"/api-reference/areas/create-an-area-type"},{"title":"Get an area type","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/area-types/{id}","href":"/api-reference/areas/get-an-area-type"},{"title":"Update an area type","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/area-types/{id}","href":"/api-reference/areas/update-an-area-type"},{"title":"Reorder area types","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/area-types/order","href":"/api-reference/areas/reorder-area-types"},{"title":"List bookable areas","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/areas","href":"/api-reference/areas/list-bookable-areas"},{"title":"Create an area","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/areas","href":"/api-reference/areas/create-an-area"},{"title":"Get area availability","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/areas/{areaId}/availability","href":"/api-reference/areas/get-area-availability"},{"title":"Get an area","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/areas/{areaId}","href":"/api-reference/areas/get-an-area"},{"title":"Update an area","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/areas/{areaId}","href":"/api-reference/areas/update-an-area"},{"title":"Get club-wide availability grid","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/availability","href":"/api-reference/areas/get-club-wide-availability-grid"},{"title":"Availability change feed (reconciliation)","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/availability/changes","href":"/api-reference/areas/availability-change-feed-reconciliation"}]},{"group":"Booking Policies","pages":[{"title":"List booking policies","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/booking-policies","href":"/api-reference/booking-policies/list-booking-policies"},{"title":"Create a booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/booking-policies","href":"/api-reference/booking-policies/create-a-booking-policy"},{"title":"Resolve the effective booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/booking-policies/effective","href":"/api-reference/booking-policies/resolve-the-effective-booking-policy"},{"title":"Get a booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/booking-policies/{id}","href":"/api-reference/booking-policies/get-a-booking-policy"},{"title":"Delete a booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/booking-policies/{id}","href":"/api-reference/booking-policies/delete-a-booking-policy"},{"title":"Update a booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/booking-policies/{id}","href":"/api-reference/booking-policies/update-a-booking-policy"},{"title":"Duplicate a booking policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/booking-policies/{id}/duplicate","href":"/api-reference/booking-policies/duplicate-a-booking-policy"}]},{"group":"Bookings","pages":[{"title":"List bookings","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/bookings","href":"/api-reference/bookings/list-bookings"},{"title":"Create a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/bookings","href":"/api-reference/bookings/create-a-booking"},{"title":"Cancel a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/bookings/{id}/cancel","href":"/api-reference/bookings/cancel-a-booking"},{"title":"Get a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/bookings/{id}","href":"/api-reference/bookings/get-a-booking"},{"title":"Delete a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/bookings/{id}","href":"/api-reference/bookings/delete-a-booking"},{"title":"Update a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/bookings/{id}","href":"/api-reference/bookings/update-a-booking"},{"title":"Waive a booking's Cancellation Charge","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/bookings/{id}/cancellation-charge/waive","href":"/api-reference/bookings/waive-a-bookings-cancellation-charge"},{"title":"List the additional players on a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/bookings/{id}/participants","href":"/api-reference/bookings/list-the-additional-players-on-a-booking"},{"title":"Add a player to a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/bookings/{id}/participants","href":"/api-reference/bookings/add-a-player-to-a-booking"},{"title":"Remove a player from a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/bookings/{id}/participants/{contactId}","href":"/api-reference/bookings/remove-a-player-from-a-booking"}]},{"group":"Check-ins","pages":[{"title":"List check-ins","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/checkins","href":"/api-reference/check-ins/list-check-ins"},{"title":"Check in a booking or a member","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/checkins","href":"/api-reference/check-ins/check-in-a-booking-or-a-member"},{"title":"Get a check-in","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/checkins/{id}","href":"/api-reference/check-ins/get-a-check-in"}]},{"group":"Classes","pages":[{"title":"List class types","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/class-types","href":"/api-reference/classes/list-class-types"},{"title":"Create a class type","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/class-types","href":"/api-reference/classes/create-a-class-type"},{"title":"Get a class type","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/class-types/{id}","href":"/api-reference/classes/get-a-class-type"},{"title":"Update a class type","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/class-types/{id}","href":"/api-reference/classes/update-a-class-type"},{"title":"Reorder class types","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/class-types/order","href":"/api-reference/classes/reorder-class-types"},{"title":"List classes","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/classes","href":"/api-reference/classes/list-classes"},{"title":"Create a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/classes","href":"/api-reference/classes/create-a-class"},{"title":"List a class's roster","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/classes/{id}/bookings","href":"/api-reference/classes/list-a-classs-roster"},{"title":"Book a customer into a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/classes/{id}/bookings","href":"/api-reference/classes/book-a-customer-into-a-class"},{"title":"Get a class by ID","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/classes/{id}","href":"/api-reference/classes/get-a-class-by-id"},{"title":"Delete a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/classes/{id}","href":"/api-reference/classes/delete-a-class"},{"title":"Update a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/classes/{id}","href":"/api-reference/classes/update-a-class"},{"title":"List programs","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/programs","href":"/api-reference/classes/list-programs"},{"title":"Create a program","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/programs","href":"/api-reference/classes/create-a-program"},{"title":"Get a program","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/programs/{id}","href":"/api-reference/classes/get-a-program"},{"title":"Update a program","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/programs/{id}","href":"/api-reference/classes/update-a-program"},{"title":"List progression tracks","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/progression-tracks","href":"/api-reference/classes/list-progression-tracks"},{"title":"Create a progression track","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/progression-tracks","href":"/api-reference/classes/create-a-progression-track"},{"title":"Get a progression track","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/progression-tracks/{id}","href":"/api-reference/classes/get-a-progression-track"},{"title":"Update a progression track","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/progression-tracks/{id}","href":"/api-reference/classes/update-a-progression-track"}]},{"group":"Clubs","pages":[{"title":"List clubs","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/clubs","href":"/api-reference/clubs/list-clubs"},{"title":"Get club details by slug","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/clubs/{slug}","href":"/api-reference/clubs/get-club-details-by-slug"},{"title":"Update a club's booking-card labels","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/clubs/{slug}","href":"/api-reference/clubs/update-a-clubs-booking-card-labels"},{"title":"Update a club's profile","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/clubs/{slug}/profile","href":"/api-reference/clubs/update-a-clubs-profile"}]},{"group":"Competitors","pages":[{"title":"List competitors","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors","href":"/api-reference/competitors/list-competitors"},{"title":"Add a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/competitors","href":"/api-reference/competitors/add-a-competitor"},{"title":"Compare prices with the market","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors/market","href":"/api-reference/competitors/compare-prices-with-the-market"},{"title":"Import competitors from the AI report","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/competitors/import-ai-report","href":"/api-reference/competitors/import-competitors-from-the-ai-report"},{"title":"Get a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors/{id}","href":"/api-reference/competitors/get-a-competitor"},{"title":"Remove a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/competitors/{id}","href":"/api-reference/competitors/remove-a-competitor"},{"title":"Update a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/competitors/{id}","href":"/api-reference/competitors/update-a-competitor"},{"title":"Analyse a competitor's reviews","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors/{id}/analysis","href":"/api-reference/competitors/analyse-a-competitors-reviews"},{"title":"Read a competitor's website again","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/competitors/{id}/refresh","href":"/api-reference/competitors/read-a-competitors-website-again"}]},{"group":"Contacts","pages":[{"title":"List and search contacts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts","href":"/api-reference/contacts/list-and-search-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Archive a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/contacts/{id}","href":"/api-reference/contacts/archive-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/contacts/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"List sales pipeline stages","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pipeline-stages","href":"/api-reference/contacts/list-sales-pipeline-stages"},{"title":"List contact sources","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contact-sources","href":"/api-reference/contacts/list-contact-sources"},{"title":"List a track's members","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/progression-tracks/{id}/members","href":"/api-reference/contacts/list-a-tracks-members"},{"title":"Give members a rank","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/progression-tracks/{id}/ranks","href":"/api-reference/contacts/give-members-a-rank"},{"title":"Get a contact's ranks","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts/{contactId}/progression","href":"/api-reference/contacts/get-a-contacts-ranks"}]},{"group":"Content","pages":[{"title":"List content","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/content","href":"/api-reference/content/list-content"},{"title":"Create content","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/content","href":"/api-reference/content/create-content"},{"title":"Get published content by slug","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/content/{slug}","href":"/api-reference/content/get-published-content-by-slug"},{"title":"Delete content","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/content/{contentId}","href":"/api-reference/content/delete-content"},{"title":"Update content","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/content/{contentId}","href":"/api-reference/content/update-content"}]},{"group":"Custom Fields","pages":[{"title":"List contact custom fields","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/custom-fields","href":"/api-reference/custom-fields/list-contact-custom-fields"},{"title":"Create a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/custom-fields","href":"/api-reference/custom-fields/create-a-contact-custom-field"},{"title":"Get a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/custom-fields/{id}","href":"/api-reference/custom-fields/get-a-contact-custom-field"},{"title":"Delete a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/custom-fields/{id}","href":"/api-reference/custom-fields/delete-a-contact-custom-field"},{"title":"Update a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/custom-fields/{id}","href":"/api-reference/custom-fields/update-a-contact-custom-field"},{"title":"Get a contact's custom field values","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts/{contactId}/custom-fields","href":"/api-reference/custom-fields/get-a-contacts-custom-field-values"},{"title":"Set a contact's custom field values","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/contacts/{contactId}/custom-fields","href":"/api-reference/custom-fields/set-a-contacts-custom-field-values"}]},{"group":"Document Rules","pages":[{"title":"List document rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/document-rules","href":"/api-reference/document-rules/list-document-rules"},{"title":"Create a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/document-rules","href":"/api-reference/document-rules/create-a-document-rule"},{"title":"Get a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/document-rules/{id}","href":"/api-reference/document-rules/get-a-document-rule"},{"title":"Delete a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/document-rules/{id}","href":"/api-reference/document-rules/delete-a-document-rule"},{"title":"Update a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/document-rules/{id}","href":"/api-reference/document-rules/update-a-document-rule"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/events","href":"/api-reference/events/list-events"},{"title":"Create an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events","href":"/api-reference/events/create-an-event"},{"title":"Get an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/events/{id}","href":"/api-reference/events/get-an-event"},{"title":"Delete an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/events/{id}","href":"/api-reference/events/delete-an-event"},{"title":"Update an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/events/{id}","href":"/api-reference/events/update-an-event"},{"title":"Publish an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/publish","href":"/api-reference/events/publish-an-event"},{"title":"Unpublish an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/unpublish","href":"/api-reference/events/unpublish-an-event"},{"title":"Cancel an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/cancel","href":"/api-reference/events/cancel-an-event"},{"title":"Duplicate an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/duplicate","href":"/api-reference/events/duplicate-an-event"},{"title":"List an event's attendees","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/events/{id}/bookings","href":"/api-reference/events/list-an-events-attendees"},{"title":"Register a customer for an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/bookings","href":"/api-reference/events/register-a-customer-for-an-event"}]},{"group":"External Programs","pages":[{"title":"List external programs","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/external-programs","href":"/api-reference/external-programs/list-external-programs"},{"title":"Create an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/external-programs","href":"/api-reference/external-programs/create-an-external-program"},{"title":"Get an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/external-programs/{id}","href":"/api-reference/external-programs/get-an-external-program"},{"title":"Delete an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/external-programs/{id}","href":"/api-reference/external-programs/delete-an-external-program"},{"title":"Update an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/external-programs/{id}","href":"/api-reference/external-programs/update-an-external-program"}]},{"group":"Forms","pages":[{"title":"List forms","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/forms","href":"/api-reference/forms/list-forms"},{"title":"Create a form","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/forms","href":"/api-reference/forms/create-a-form"},{"title":"Get a form","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/forms/{id}","href":"/api-reference/forms/get-a-form"},{"title":"Update a form","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/forms/{id}","href":"/api-reference/forms/update-a-form"},{"title":"Set a fill-in form's questions","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/forms/{id}/questions","href":"/api-reference/forms/set-a-fill-in-forms-questions"}]},{"group":"Staff Roster","pages":[{"title":"List the staff roster","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-shifts","href":"/api-reference/staff-roster/list-the-staff-roster"},{"title":"Add a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-shifts","href":"/api-reference/staff-roster/add-a-shift"},{"title":"Get a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-shifts/{id}","href":"/api-reference/staff-roster/get-a-shift"},{"title":"Delete a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/instructor-shifts/{id}","href":"/api-reference/staff-roster/delete-a-shift"},{"title":"Edit a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructor-shifts/{id}","href":"/api-reference/staff-roster/edit-a-shift"},{"title":"Cancel a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-shifts/{id}/cancel","href":"/api-reference/staff-roster/cancel-a-shift"},{"title":"List instructor time off","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-time-off","href":"/api-reference/staff-roster/list-instructor-time-off"},{"title":"Book a coach off","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-time-off","href":"/api-reference/staff-roster/book-a-coach-off"},{"title":"Remove instructor time off","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/instructor-time-off/{id}","href":"/api-reference/staff-roster/remove-instructor-time-off"},{"title":"Change instructor time off","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructor-time-off/{id}","href":"/api-reference/staff-roster/change-instructor-time-off"},{"title":"List rotation assignments","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-rotation-assignments","href":"/api-reference/staff-roster/list-rotation-assignments"},{"title":"Assign a coach to a rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/shift-rotation-assignments","href":"/api-reference/staff-roster/assign-a-coach-to-a-rotation"},{"title":"Remove a rotation assignment","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/shift-rotation-assignments/{id}","href":"/api-reference/staff-roster/remove-a-rotation-assignment"},{"title":"Update a rotation assignment","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/shift-rotation-assignments/{id}","href":"/api-reference/staff-roster/update-a-rotation-assignment"},{"title":"List shift rotations","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-rotations","href":"/api-reference/staff-roster/list-shift-rotations"},{"title":"Create a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/shift-rotations","href":"/api-reference/staff-roster/create-a-shift-rotation"},{"title":"Get a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-rotations/{id}","href":"/api-reference/staff-roster/get-a-shift-rotation"},{"title":"Delete a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/shift-rotations/{id}","href":"/api-reference/staff-roster/delete-a-shift-rotation"},{"title":"Update a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/shift-rotations/{id}","href":"/api-reference/staff-roster/update-a-shift-rotation"},{"title":"List shift templates","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-templates","href":"/api-reference/staff-roster/list-shift-templates"},{"title":"Create a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/shift-templates","href":"/api-reference/staff-roster/create-a-shift-template"},{"title":"Get a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-templates/{id}","href":"/api-reference/staff-roster/get-a-shift-template"},{"title":"Delete a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/shift-templates/{id}","href":"/api-reference/staff-roster/delete-a-shift-template"},{"title":"Update a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/shift-templates/{id}","href":"/api-reference/staff-roster/update-a-shift-template"}]},{"group":"Instructors","pages":[{"title":"List instructor types","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-types","href":"/api-reference/instructors/list-instructor-types"},{"title":"Create an instructor type","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-types","href":"/api-reference/instructors/create-an-instructor-type"},{"title":"Get an instructor type","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-types/{id}","href":"/api-reference/instructors/get-an-instructor-type"},{"title":"Update an instructor type","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructor-types/{id}","href":"/api-reference/instructors/update-an-instructor-type"},{"title":"Reorder instructor types","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/instructor-types/order","href":"/api-reference/instructors/reorder-instructor-types"},{"title":"List and search instructors","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructors","href":"/api-reference/instructors/list-and-search-instructors"},{"title":"Create an instructor","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructors","href":"/api-reference/instructors/create-an-instructor"},{"title":"Get an instructor","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructors/{id}","href":"/api-reference/instructors/get-an-instructor"},{"title":"Update an instructor","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructors/{id}","href":"/api-reference/instructors/update-an-instructor"}]},{"group":"Invoices","pages":[{"title":"Summarize what was invoiced","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/invoices/summary","href":"/api-reference/invoices/summarize-what-was-invoiced"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/invoices/{id}","href":"/api-reference/invoices/get-an-invoice"}]},{"group":"Account","pages":[{"title":"Describe the API key's organization and granted scopes","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/me","href":"/api-reference/account/describe-the-api-keys-organization-and-granted-scopes"}]},{"group":"Media","pages":[{"title":"List media","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/media","href":"/api-reference/media/list-media"},{"title":"Register a file in the media library","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/media","href":"/api-reference/media/register-a-file-in-the-media-library"},{"title":"Get one media item","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/media/{mediaId}","href":"/api-reference/media/get-one-media-item"},{"title":"Delete a media item","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/media/{mediaId}","href":"/api-reference/media/delete-a-media-item"},{"title":"Update media metadata","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/media/{mediaId}","href":"/api-reference/media/update-media-metadata"}]},{"group":"Member Accounts","pages":[{"title":"List household and company accounts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/member-accounts","href":"/api-reference/member-accounts/list-household-and-company-accounts"},{"title":"Create a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/member-accounts","href":"/api-reference/member-accounts/create-a-household-or-company-account"},{"title":"Get a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/member-accounts/{id}","href":"/api-reference/member-accounts/get-a-household-or-company-account"},{"title":"Delete a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/member-accounts/{id}","href":"/api-reference/member-accounts/delete-a-household-or-company-account"},{"title":"Update a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/member-accounts/{id}","href":"/api-reference/member-accounts/update-a-household-or-company-account"},{"title":"Add a member to an account","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/member-accounts/{id}/members","href":"/api-reference/member-accounts/add-a-member-to-an-account"},{"title":"Remove a member from an account","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/member-accounts/{id}/members/{contactId}","href":"/api-reference/member-accounts/remove-a-member-from-an-account"},{"title":"Change a member's role","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/member-accounts/{id}/members/{contactId}","href":"/api-reference/member-accounts/change-a-members-role"}]},{"group":"Memberships","pages":[{"title":"List memberships","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/memberships","href":"/api-reference/memberships/list-memberships"},{"title":"Create a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/memberships","href":"/api-reference/memberships/create-a-membership"},{"title":"Get a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/memberships/{id}","href":"/api-reference/memberships/get-a-membership"},{"title":"Update a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/memberships/{id}","href":"/api-reference/memberships/update-a-membership"},{"title":"Adjust a membership's sessions","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/memberships/{id}/session-adjustments","href":"/api-reference/memberships/adjust-a-memberships-sessions"},{"title":"Extend a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/memberships/{id}/extensions","href":"/api-reference/memberships/extend-a-membership"}]},{"group":"Messages","pages":[{"title":"List messages","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/messages","href":"/api-reference/messages/list-messages"},{"title":"Create a message draft","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/messages","href":"/api-reference/messages/create-a-message-draft"},{"title":"Get a message","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/messages/{id}","href":"/api-reference/messages/get-a-message"},{"title":"Delete a message draft","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/messages/{id}","href":"/api-reference/messages/delete-a-message-draft"},{"title":"Update a message draft","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/messages/{id}","href":"/api-reference/messages/update-a-message-draft"}]},{"group":"Notifications","pages":[{"title":"Get notification settings","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/notification-settings","href":"/api-reference/notifications/get-notification-settings"},{"title":"Update a notification setting","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/notification-settings","href":"/api-reference/notifications/update-a-notification-setting"},{"title":"Apply notification settings to everyone in a role","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/notification-settings/apply","href":"/api-reference/notifications/apply-notification-settings-to-everyone-in-a-role"}]},{"group":"Pay Rate Policies","pages":[{"title":"List what coaches earned","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pay-ledger","href":"/api-reference/pay-rate-policies/list-what-coaches-earned"},{"title":"List pay rate policies","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pay-rate-policies","href":"/api-reference/pay-rate-policies/list-pay-rate-policies"},{"title":"Create a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pay-rate-policies","href":"/api-reference/pay-rate-policies/create-a-pay-rate-policy"},{"title":"Get a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pay-rate-policies/{id}","href":"/api-reference/pay-rate-policies/get-a-pay-rate-policy"},{"title":"Update a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/pay-rate-policies/{id}","href":"/api-reference/pay-rate-policies/update-a-pay-rate-policy"},{"title":"Put instructors on a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pay-rate-policies/{id}/instructors","href":"/api-reference/pay-rate-policies/put-instructors-on-a-pay-rate-policy"},{"title":"Take an instructor off a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/pay-rate-policies/{id}/instructors/{instructorId}","href":"/api-reference/pay-rate-policies/take-an-instructor-off-a-pay-rate-policy"}]},{"group":"Payment Methods","pages":[{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/payment-methods","href":"/api-reference/payment-methods/list-payment-methods"},{"title":"Create a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/payment-methods","href":"/api-reference/payment-methods/create-a-payment-method"},{"title":"Get a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/payment-methods/{id}","href":"/api-reference/payment-methods/get-a-payment-method"},{"title":"Delete a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/payment-methods/{id}","href":"/api-reference/payment-methods/delete-a-payment-method"},{"title":"Update a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/payment-methods/{id}","href":"/api-reference/payment-methods/update-a-payment-method"}]},{"group":"Plans","pages":[{"title":"List membership plan categories","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plan-categories","href":"/api-reference/plans/list-membership-plan-categories"},{"title":"Create a membership plan category","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/plan-categories","href":"/api-reference/plans/create-a-membership-plan-category"},{"title":"Get a membership plan category","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plan-categories/{id}","href":"/api-reference/plans/get-a-membership-plan-category"},{"title":"Update a membership plan category","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/plan-categories/{id}","href":"/api-reference/plans/update-a-membership-plan-category"},{"title":"List and search membership plans","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plans","href":"/api-reference/plans/list-and-search-membership-plans"},{"title":"Create a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/plans","href":"/api-reference/plans/create-a-membership-plan"},{"title":"Get a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plans/{id}","href":"/api-reference/plans/get-a-membership-plan"},{"title":"Delete a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/plans/{id}","href":"/api-reference/plans/delete-a-membership-plan"},{"title":"Update a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/plans/{id}","href":"/api-reference/plans/update-a-membership-plan"}]},{"group":"Pricing Rules","pages":[{"title":"List pricing rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pricing-rules","href":"/api-reference/pricing-rules/list-pricing-rules"},{"title":"Create a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pricing-rules","href":"/api-reference/pricing-rules/create-a-pricing-rule"},{"title":"Quote a booking price","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pricing-rules/quote","href":"/api-reference/pricing-rules/quote-a-booking-price"},{"title":"Get a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pricing-rules/{id}","href":"/api-reference/pricing-rules/get-a-pricing-rule"},{"title":"Delete a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/pricing-rules/{id}","href":"/api-reference/pricing-rules/delete-a-pricing-rule"},{"title":"Update a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/pricing-rules/{id}","href":"/api-reference/pricing-rules/update-a-pricing-rule"}]},{"group":"Products","pages":[{"title":"List product categories","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/product-categories","href":"/api-reference/products/list-product-categories"},{"title":"Create a product category","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/product-categories","href":"/api-reference/products/create-a-product-category"},{"title":"Get a product category","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/product-categories/{id}","href":"/api-reference/products/get-a-product-category"},{"title":"Update a product category","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/product-categories/{id}","href":"/api-reference/products/update-a-product-category"},{"title":"List and search products","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/products","href":"/api-reference/products/list-and-search-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/products","href":"/api-reference/products/create-a-product"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/products/{id}","href":"/api-reference/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/products/{id}","href":"/api-reference/products/update-a-product"},{"title":"Get how many are left to sell","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/products/{id}/availability","href":"/api-reference/products/get-how-many-are-left-to-sell"}]},{"group":"Promotions","pages":[{"title":"List promotions","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/promotions","href":"/api-reference/promotions/list-promotions"},{"title":"Create a promotion","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/promotions","href":"/api-reference/promotions/create-a-promotion"},{"title":"Get a promotion","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/promotions/{id}","href":"/api-reference/promotions/get-a-promotion"},{"title":"Delete a promotion","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/promotions/{id}","href":"/api-reference/promotions/delete-a-promotion"},{"title":"Update a promotion","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/promotions/{id}","href":"/api-reference/promotions/update-a-promotion"}]},{"group":"Reports","pages":[{"title":"Revenue report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/revenue","href":"/api-reference/reports/revenue-report-for-a-period"},{"title":"Activity report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/activity","href":"/api-reference/reports/activity-report-for-a-period"},{"title":"Memberships report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/memberships","href":"/api-reference/reports/memberships-report-for-a-period"},{"title":"Members report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/members","href":"/api-reference/reports/members-report-for-a-period"},{"title":"What each report figure counts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/definitions","href":"/api-reference/reports/what-each-report-figure-counts"},{"title":"What one report figure counts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/definitions/{metric}","href":"/api-reference/reports/what-one-report-figure-counts"},{"title":"Tax report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/tax","href":"/api-reference/reports/tax-report-for-a-period"},{"title":"The sales behind the Tax report","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/tax/charges","href":"/api-reference/reports/the-sales-behind-the-tax-report"},{"title":"Who owes the organization, and for how long","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/amount-due","href":"/api-reference/reports/who-owes-the-organization-and-for-how-long"},{"title":"Every booking of a period and where its money stands","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/booking-audit","href":"/api-reference/reports/every-booking-of-a-period-and-where-its-money-stands"},{"title":"Who is at risk of leaving","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/at-risk","href":"/api-reference/reports/who-is-at-risk-of-leaving"},{"title":"Which memberships end soon","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/renewals","href":"/api-reference/reports/which-memberships-end-soon"},{"title":"Who is ready for their next rank","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/promotion-eligibility","href":"/api-reference/reports/who-is-ready-for-their-next-rank"},{"title":"Who cancels, how late, and where","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/cancellations","href":"/api-reference/reports/who-cancels-how-late-and-where"}]},{"group":"Revenue Accounts","pages":[{"title":"List revenue accounts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/revenue-accounts","href":"/api-reference/revenue-accounts/list-revenue-accounts"},{"title":"Create a revenue account","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/revenue-accounts","href":"/api-reference/revenue-accounts/create-a-revenue-account"},{"title":"Get a revenue account","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/revenue-accounts/{id}","href":"/api-reference/revenue-accounts/get-a-revenue-account"},{"title":"Update a revenue account","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/revenue-accounts/{id}","href":"/api-reference/revenue-accounts/update-a-revenue-account"}]},{"group":"Setup","pages":[{"title":"Get the club setup checklist","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/setup-checklist","href":"/api-reference/setup/get-the-club-setup-checklist"},{"title":"Mark a setup step","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/setup-checklist/steps/{step}","href":"/api-reference/setup/mark-a-setup-step"}]},{"group":"Staff","pages":[{"title":"List staff","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/staff","href":"/api-reference/staff/list-staff"},{"title":"Change a staff member's role","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/staff/{userId}/role","href":"/api-reference/staff/change-a-staff-members-role"},{"title":"Get role permissions","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/role-permissions","href":"/api-reference/staff/get-role-permissions"},{"title":"Reset a role's permissions","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/role-permissions/{role}","href":"/api-reference/staff/reset-a-roles-permissions"},{"title":"Change a role's permissions","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/role-permissions/{role}","href":"/api-reference/staff/change-a-roles-permissions"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/tags/{id}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/tags/{id}","href":"/api-reference/tags/update-a-tag"},{"title":"Tag contacts","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/contact-tags/add","href":"/api-reference/tags/tag-contacts"},{"title":"Untag contacts","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/contact-tags/remove","href":"/api-reference/tags/untag-contacts"},{"title":"Get smart tag rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/smart-tag-settings","href":"/api-reference/tags/get-smart-tag-rules"},{"title":"Update smart tag rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/smart-tag-settings","href":"/api-reference/tags/update-smart-tag-rules"}]},{"group":"Templates","pages":[{"title":"List message templates","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates","href":"/api-reference/templates/list-message-templates"},{"title":"Create a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/templates","href":"/api-reference/templates/create-a-message-template"},{"title":"List the variables a template may use","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates/variables","href":"/api-reference/templates/list-the-variables-a-template-may-use"},{"title":"List the customizable system emails","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates/system","href":"/api-reference/templates/list-the-customizable-system-emails"},{"title":"Customize a system email","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/templates/system/{key}/copy","href":"/api-reference/templates/customize-a-system-email"},{"title":"Get a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates/{id}","href":"/api-reference/templates/get-a-message-template"},{"title":"Delete a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/templates/{id}","href":"/api-reference/templates/delete-a-message-template"},{"title":"Update a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/templates/{id}","href":"/api-reference/templates/update-a-message-template"}]},{"group":"Transactions","pages":[{"title":"List transactions for the organization","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/transactions","href":"/api-reference/transactions/list-transactions-for-the-organization"},{"title":"Record a settlement","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions","href":"/api-reference/transactions/record-a-settlement"},{"title":"Get a transaction by ID","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/transactions/{id}","href":"/api-reference/transactions/get-a-transaction-by-id"},{"title":"Delete an unpaid charge","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/transactions/{id}","href":"/api-reference/transactions/delete-an-unpaid-charge"},{"title":"Refund a settlement","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/refund","href":"/api-reference/transactions/refund-a-settlement"},{"title":"Void an unpaid charge","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/void","href":"/api-reference/transactions/void-an-unpaid-charge"},{"title":"Record a payment for a charge","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/record-payment","href":"/api-reference/transactions/record-a-payment-for-a-charge"},{"title":"Charge a charge to the member's saved card","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/charge-saved-card","href":"/api-reference/transactions/charge-a-charge-to-the-members-saved-card"}]},{"group":"Website","pages":[{"title":"Get the website","description":"Returns one website with its page list, layout, publish state and public URLs. Omit `siteId` for the organization's default website.\n`previewUrl` renders the unpublished draft, which is how you review edits made through this API before publishing them; `url` is what the public sees and only reflects the last published release.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website","href":"/api-reference/website/get-the-website"},{"title":"Update website-level settings","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/website","href":"/api-reference/website/update-website-level-settings"},{"title":"List the organization's websites","description":"Every website the organization owns, its default one first. Use this when the organization runs more than one site to find the `siteId` the other endpoints take.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/sites","href":"/api-reference/website/list-the-organizations-websites"},{"title":"Create a website from a Website Template","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/sites","href":"/api-reference/website/create-a-website-from-a-website-template"},{"title":"Get the section-type catalog","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/section-types","href":"/api-reference/website/get-the-section-type-catalog"},{"title":"Get the design-token catalog","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/theme-tokens","href":"/api-reference/website/get-the-design-token-catalog"},{"title":"Get the website's theme","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/theme","href":"/api-reference/website/get-the-websites-theme"},{"title":"Set the website's design tokens","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/website/theme","href":"/api-reference/website/set-the-websites-design-tokens"},{"title":"Get the website's custom CSS","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/css","href":"/api-reference/website/get-the-websites-custom-css"},{"title":"Replace the website's custom CSS","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/website/css","href":"/api-reference/website/replace-the-websites-custom-css"},{"title":"List the website's pages","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/pages","href":"/api-reference/website/list-the-websites-pages"},{"title":"Add a page","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/pages","href":"/api-reference/website/add-a-page"},{"title":"Get one page","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/pages/{slug}","href":"/api-reference/website/get-one-page"},{"title":"Update a page","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/website/pages/{slug}","href":"/api-reference/website/update-a-page"},{"title":"Delete a page","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/website/pages/{slug}","href":"/api-reference/website/delete-a-page"},{"title":"List publish history","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/releases","href":"/api-reference/website/list-publish-history"},{"title":"Publish the website","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/releases","href":"/api-reference/website/publish-the-website"},{"title":"Add a section to a page","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/pages/{slug}/sections","href":"/api-reference/website/add-a-section-to-a-page"},{"title":"Remove a section from a page","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/website/pages/{slug}/sections/{index}","href":"/api-reference/website/remove-a-section-from-a-page"},{"title":"Update a section's config","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/website/pages/{slug}/sections/{index}","href":"/api-reference/website/update-a-sections-config"},{"title":"Update the site header or footer","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/website/layout/{slot}","href":"/api-reference/website/update-the-site-header-or-footer"},{"title":"Roll back to an earlier release","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/releases/{releaseId}/rollback","href":"/api-reference/website/roll-back-to-an-earlier-release"}]},{"group":"Automations","pages":[{"title":"List automations","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/automations","href":"/api-reference/automations/list-automations"},{"title":"Get an automation","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/automations/{id}","href":"/api-reference/automations/get-an-automation"}]},{"group":"Brand Book","pages":[{"title":"Get the Brand Book","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/brand-book","href":"/api-reference/brand-book/get-the-brand-book"},{"title":"Update the Brand Book","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/brand-book","href":"/api-reference/brand-book/update-the-brand-book"}]},{"group":"Contact notes","pages":[{"title":"List contact notes","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contact-notes","href":"/api-reference/contact-notes/list-contact-notes"}]},{"group":"Form submissions","pages":[{"title":"List form submissions","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/form-submissions","href":"/api-reference/form-submissions/list-form-submissions"}]},{"group":"Reviews","pages":[{"title":"List reviews","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reviews","href":"/api-reference/reviews/list-reviews"},{"title":"Get a review","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reviews/{id}","href":"/api-reference/reviews/get-a-review"}]},{"group":"Platform Website","pages":[{"title":"List the Website Templates","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/templates","href":"/api-reference/platform-website/list-the-website-templates"},{"title":"Give the website a template's look","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/templates/{templateKey}/apply-look","href":"/api-reference/platform-website/give-the-website-a-templates-look"},{"title":"Rewrite the website's copy for the business","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/website/personalize-copy","href":"/api-reference/platform-website/rewrite-the-websites-copy-for-the-business"},{"title":"What the website still needs","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/website/readiness","href":"/api-reference/platform-website/what-the-website-still-needs"}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Update website-level settings - 1club Help","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}