Updates one occurrence, or this and all future occurrences when scope=all_future. A recurring class defaults to this_instance, so a series-wide edit must ask for it explicitly.
With scope=all_future, recurrence moves where the series ends - ends plus endDate, the same fields a create takes. Send it on its own: a body that also carries class fields is refused, so an end change never half-applies. Only the end: a frequency, interval or daysOfWeek is refused, and to change a cadence you delete the remaining series and create it again. A later end writes the new occurrences; an earlier one removes the occurrences past it, and is refused with 409 when any of those has an active booking or waitlist entry (cancel them first) - nothing a member holds is cancelled as a side effect. The occurrence named must be one the series keeps, and the end cannot fall before a session that has already run.
The response to an end change carries series.occurrencesCreated and series.occurrencesRemoved. As on a create, an occurrence at a club that is closed is skipped rather than failing the request, so compare the count with what you expected.
Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.
Path Parameters
id
integer
required
Query Parameters
scope
enum<string>
default:this_instance
Whether the update applies to this occurrence only or to this and every later one in the series
Available options:
this_instance,
all_future
Body
application/json
clubId
integer
instructorLocationId
integer | null
Where the class happens, when that is one of its instructors' locations (GET /v1/platform/instructors/{id} locations) rather than an area of its club. Required for a Professional's class (INSTRUCTOR_LOCATION_REQUIRED), whose club is its business and not a place. The class then takes no areaId.
areaId
integer | null
classTypeId
integer | null
instructorIds
integer[]
Maximum array length: 20
name
string
Maximum string length: 100
description
string | null
Maximum string length: 5000
priceBeforeTax
number
The price to store, excluding tax - the same field reads return. The tax-inclusive price a class reads back with is computed and cannot be written: sending it is a 400, because posting it back would re-apply tax on every round trip.
Required range: x >= 0
isFree
boolean
maxCapacity
integer | null
Required range: x >= 1
startTime
string<date-time>
ISO 8601 instant with an explicit offset.
endTime
string<date-time>
ISO 8601 instant with an explicit offset.
visibility
enum<string>
Available options:
Private,
Member_only,
Public
sport
string | null
Maximum string length: 60
color
string
Pattern: ^#[0-9a-fA-F]{6}$
recurrence
object
Moves where the series this occurrence belongs to ends; needs scope=all_future, and is sent on its own - a body that also carries class fields is rejected. Only the end - a cadence field is rejected. An earlier end removes the occurrences past it and is refused with 409 while any of them has an active booking or waitlist entry.
Show child attributes
notifyCustomer
boolean
default:false
Tell the people booked on this class what changed - email plus the in-app and WhatsApp notification. Only sent when the edit changes something visible on their booking (start/end time, area, club, or the instructors); a rename or a price change notifies nobody. Off by default, so callers normally send their own. Assigned instructors get their calendar update either way.
Response
Class updated
One class occurrence. A weekly class materializes a row per session, linked by recurrenceId and occurrenceIndex, so id is what a booking's classId points at - and what distinguishes two groups running in the same hour. Read the staff roster with GET /v1/platform/classes/{id}/bookings.
id
integer
name
string
slug
string | null
description
string | null
images
string[]
classTypeId
integer | null
classType
object | null
Show child attributes
clubId
integer
instructorLocationId
integer | null
Where the class happens when that is one of its instructors' locations rather than its club: always set for a Professional's class.
club
object | null
Show child attributes
areaId
integer | null
Room or court the class occupies, when one is assigned.
area
object | null
Show child attributes
startTime
string<date-time>
endTime
string<date-time>
durationMinutes
integer
isMultiDay
boolean
status
enum<string>
A cancelled occurrence keeps its bookings and roster.
Available options:
active,
cancelled
visibility
enum<string>
Available options:
Public,
Member_only,
Private
sport
string | null
color
string | null
price
number<float> | null
Price including the organization's default tax - what a member is charged.
priceBeforeTax
number<float> | null
The price as stored on the class, before tax.
isFree
boolean
maxCapacity
integer | null
Seats; null when uncapped.
maxPartySize
integer
Largest party one booking may bring, from the class type.
bookedCount
integer
Seats taken: attendee bookings plus standalone walk-in check-ins.
currentBookings
integer
Legacy alias of bookedCount.
spotsLeft
integer | null
maxCapacity - bookedCount, floored at 0; null when capacity is unlimited.
waitlistCount
integer
Entries waiting (pending or notified).
allowWaitlist
boolean
timeStatus
enum<string>
Available options:
past,
upcoming
availabilityStatus
enum<string>
Available options:
available,
full
recurrenceId
integer | null
The series this occurrence belongs to; null for a one-off class.
occurrenceIndex
integer | null
Position within the series, as materialized.
recurrence
object | null
The series rule, when this occurrence belongs to one.
Show child attributes
instructors
object[]
Who teaches the occurrence. The instructor's own weekly availability is not included; read it from GET /v1/platform/instructors.
Show child attributes
externalSource
string | null
Import provenance - set when the occurrence came from an external system rather than being created in 1club.
externalId
string | null
The source system's id for this occurrence, for reconciliation against it.
createdAt
string<date-time>
updatedAt
string<date-time>
translations
object | null
Every locale's copy, keyed by language code (e.g. 'es', 'fr'). Returned alongside the locale-resolved name/description, so an integration syncing a multilingual timetable can read all of them in one call.
series
object
Present only on the response to a recurring create or to an update that moved where the series ends, never on a read: it describes what that one request did. An occurrence at a club that is closed, or past its closing date, is skipped rather than failing the request, so comparing occurrencesCreated with what you asked for is the only way a partially-skipped season is visible.
Show child attributes
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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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/classes/update-a-class","slug":"/api-reference/classes/update-a-class","pageMetadata":{"title":"Update a class","description":"Updates one occurrence, or this and all future occurrences when `scope=all_future`. A recurring class defaults to `this_instance`, so a series-wide edit must ask for it explicitly.\n\nWith `scope=all_future`, `recurrence` moves where the series ends - `ends` plus `endDate`, the same fields a create takes. Send it on its own: a body that also carries class fields is refused, so an end change never half-applies. Only the end: a `frequency`, `interval` or `daysOfWeek` is refused, and to change a cadence you delete the remaining series and create it again. A later end writes the new occurrences; an earlier one removes the occurrences past it, and is refused with 409 when any of those has an active booking or waitlist entry (cancel them first) - nothing a member holds is cancelled as a side effect. The occurrence named must be one the series keeps, and the end cannot fall before a session that has already run.\n\nThe response to an end change carries `series.occurrencesCreated` and `series.occurrencesRemoved`. As on a create, an occurrence at a club that is closed is skipped rather than failing the request, so compare the count with what you expected.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/classes/{id}","href":"/api-reference/classes/update-a-class","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Updates one occurrence, or this and all future occurrences when \", _jsx(_components.code, {\n children: \"scope=all_future\"\n }), \". A recurring class defaults to \", _jsx(_components.code, {\n children: \"this_instance\"\n }), \", so a series-wide edit must ask for it explicitly.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"With \", _jsx(_components.code, {\n children: \"scope=all_future\"\n }), \", \", _jsx(_components.code, {\n children: \"recurrence\"\n }), \" moves where the series ends - \", _jsx(_components.code, {\n children: \"ends\"\n }), \" plus \", _jsx(_components.code, {\n children: \"endDate\"\n }), \", the same fields a create takes. Send it on its own: a body that also carries class fields is refused, so an end change never half-applies. Only the end: a \", _jsx(_components.code, {\n children: \"frequency\"\n }), \", \", _jsx(_components.code, {\n children: \"interval\"\n }), \" or \", _jsx(_components.code, {\n children: \"daysOfWeek\"\n }), \" is refused, and to change a cadence you delete the remaining series and create it again. A later end writes the new occurrences; an earlier one removes the occurrences past it, and is refused with 409 when any of those has an active booking or waitlist entry (cancel them first) - nothing a member holds is cancelled as a side effect. The occurrence named must be one the series keeps, and the end cannot fall before a session that has already run.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The response to an end change carries \", _jsx(_components.code, {\n children: \"series.occurrencesCreated\"\n }), \" and \", _jsx(_components.code, {\n children: \"series.occurrencesRemoved\"\n }), \". As on a create, an occurrence at a club that is closed is skipped rather than failing the request, so compare the count with what you expected.\"]\n })]\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 a class","description":"Updates one occurrence, or this and all future occurrences when `scope=all_future`. A recurring class defaults to `this_instance`, so a series-wide edit must ask for it explicitly.\n\nWith `scope=all_future`, `recurrence` moves where the series ends - `ends` plus `endDate`, the same fields a create takes. Send it on its own: a body that also carries class fields is refused, so an end change never half-applies. Only the end: a `frequency`, `interval` or `daysOfWeek` is refused, and to change a cadence you delete the remaining series and create it again. A later end writes the new occurrences; an earlier one removes the occurrences past it, and is refused with 409 when any of those has an active booking or waitlist entry (cancel them first) - nothing a member holds is cancelled as a side effect. The occurrence named must be one the series keeps, and the end cannot fall before a session that has already run.\n\nThe response to an end change carries `series.occurrencesCreated` and `series.occurrencesRemoved`. As on a create, an occurrence at a club that is closed is skipped rather than failing the request, so compare the count with what you expected.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/classes/{id}","href":"/api-reference/classes/update-a-class","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateClass","summary":"Update a class","description":"Updates one occurrence, or this and all future occurrences when `scope=all_future`. A recurring class defaults to `this_instance`, so a series-wide edit must ask for it explicitly.\n\nWith `scope=all_future`, `recurrence` moves where the series ends - `ends` plus `endDate`, the same fields a create takes. Send it on its own: a body that also carries class fields is refused, so an end change never half-applies. Only the end: a `frequency`, `interval` or `daysOfWeek` is refused, and to change a cadence you delete the remaining series and create it again. A later end writes the new occurrences; an earlier one removes the occurrences past it, and is refused with 409 when any of those has an active booking or waitlist entry (cancel them first) - nothing a member holds is cancelled as a side effect. The occurrence named must be one the series keeps, and the end cannot fall before a session that has already run.\n\nThe response to an end change carries `series.occurrencesCreated` and `series.occurrencesRemoved`. As on a create, an occurrence at a club that is closed is skipped rather than failing the request, so compare the count with what you expected.\n","tags":["Classes"],"security":["6cafe0ae-d048-403e-b9e1-09763efc2236"],"parameters":["96af6bb5-1b18-4b8c-8a01-e9c6f14dbdbb","ab55ec34-de58-449f-b4e7-1fa7c6b4d649"],"requestBody":"17cb7bb9-3531-48ed-aa26-8aa82873d47c","responses":{"200":"8a03146e-5542-4679-8d4c-18327017659e","400":"9bf23cd2-a785-4736-89bb-9905a43f14ad","403":"8ed3f12a-acee-42e4-ac79-b414a4fb6501","404":"0305a220-571e-4f6b-9893-3c68b2dc5abf","409":"98157989-7674-4c57-b8c7-b3a67fd064e6"},"method":"patch","type":"path","servers":["271bc9cb-062d-498d-90b7-92302d2b0c58"],"path":"/v1/platform/classes/{id}","baseUrlOptions":["https://api.1club.ai"],"title":"Update a class","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"96af6bb5-1b18-4b8c-8a01-e9c6f14dbdbb":{"in":"path","name":"id","required":true,"schema":{"type":"integer","isRequired":true,"uniqueKey":"","typeLabel":"integer"}},"ab55ec34-de58-449f-b4e7-1fa7c6b4d649":{"in":"query","name":"scope","schema":{"type":"string","enum":["this_instance","all_future"],"default":"this_instance","description":"Whether the update applies to this occurrence only or to this and every later one in the series","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Whether the update applies to this occurrence only or to this and every later one in the series"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"clubId":{"type":"integer","uniqueKey":"clubId","typeLabel":"integer"},"instructorLocationId":{"oneOf":[{"type":"integer","description":"Where the class happens, when that is one of its instructors' locations (GET /v1/platform/instructors/{id} `locations`) rather than an area of its club. Required for a Professional's class (`INSTRUCTOR_LOCATION_REQUIRED`), whose club is its business and not a place. The class then takes no `areaId`.","uniqueKey":"instructorLocationId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Where the class happens, when that is one of its instructors' locations (GET /v1/platform/instructors/{id} `locations`) rather than an area of its club. Required for a Professional's class (`INSTRUCTOR_LOCATION_REQUIRED`), whose club is its business and not a place. The class then takes no `areaId`.","uniqueKey":"instructorLocationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructorLocationId","typeLabel":"integer | null"},"areaId":{"oneOf":[{"type":"integer","uniqueKey":"areaId.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"areaId.oneOf.1","typeLabel":"null"}],"uniqueKey":"areaId","typeLabel":"integer | null"},"classTypeId":{"oneOf":[{"type":"integer","uniqueKey":"classTypeId.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"classTypeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"classTypeId","typeLabel":"integer | null"},"instructorIds":{"type":"array","items":{"type":"integer","uniqueKey":"instructorIds.items.[INDEX]","typeLabel":"integer"},"maxItems":20,"uniqueKey":"instructorIds","typeLabel":"integer[]"},"name":{"type":"string","maxLength":100,"uniqueKey":"name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":5000,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":5000,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"priceBeforeTax":{"type":"number","minimum":0,"description":"The price to store, excluding tax - the same field reads return. The tax-inclusive `price` a class reads back with is computed and cannot be written: sending it is a 400, because posting it back would re-apply tax on every round trip.","uniqueKey":"priceBeforeTax","typeLabel":"number"},"isFree":{"type":"boolean","uniqueKey":"isFree","typeLabel":"boolean"},"maxCapacity":{"oneOf":[{"type":"integer","minimum":1,"uniqueKey":"maxCapacity.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"uniqueKey":"maxCapacity.oneOf.1","typeLabel":"null"}],"uniqueKey":"maxCapacity","typeLabel":"integer | null"},"startTime":{"type":"string","format":"date-time","description":"ISO 8601 instant with an explicit offset.","uniqueKey":"startTime","typeLabel":"string\u003cdate-time>"},"endTime":{"type":"string","format":"date-time","description":"ISO 8601 instant with an explicit offset.","uniqueKey":"endTime","typeLabel":"string\u003cdate-time>"},"visibility":{"type":"string","enum":["Private","Member_only","Public"],"uniqueKey":"visibility","typeLabel":"enum\u003cstring>"},"sport":{"oneOf":[{"type":"string","maxLength":60,"uniqueKey":"sport.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":60,"uniqueKey":"sport.oneOf.1","typeLabel":"null"}],"uniqueKey":"sport","typeLabel":"string | null"},"color":{"type":"string","pattern":"^#[0-9a-fA-F]{6}$","uniqueKey":"color","typeLabel":"string"},"recurrence":{"type":"object","description":"Moves where the series this occurrence belongs to ends; needs `scope=all_future`, and is sent on its own - a body that also carries class fields is rejected. Only the end - a cadence field is rejected. An earlier end removes the occurrences past it and is refused with 409 while any of them has an active booking or waitlist entry.","required":["ends"],"properties":{"ends":{"type":"object","description":"How the series terminates. Omitted on a create means `never`: an open-ended series kept on a rolling window.","required":["type"],"properties":{"type":{"type":"string","enum":["until","after","never"],"isRequired":true,"uniqueKey":"recurrence.ends.type","typeLabel":"enum\u003cstring>"},"occurrences":{"type":"integer","minimum":1,"maximum":520,"description":"How many occurrences the series holds **in total**, counted from its first occurrence and across every day in `daysOfWeek` - not how many weeks. A Monday-and-Wednesday class running for twelve weeks is `24`, not `12`; sending `12` there creates six weeks. When the series ends on a date rather than after a count, `ends.type: \"until\"` with an `endDate` says so without the arithmetic. Required when `ends.type` is `after`, and rejected otherwise.","uniqueKey":"recurrence.ends.occurrences","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"recurrence.ends","typeLabel":"object"},"endDate":{"type":"string","format":"date-time","description":"Last day the series may reach, as an ISO 8601 instant with an explicit offset; an occurrence starting at or before it is kept. Required when `ends.type` is `until`, and rejected otherwise.","uniqueKey":"recurrence.endDate","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"recurrence","typeLabel":"object"},"notifyCustomer":{"type":"boolean","default":false,"description":"Tell the people booked on this class what changed - email plus the in-app and WhatsApp notification. Only sent when the edit changes something visible on their booking (start/end time, area, club, or the instructors); a rename or a price change notifies nobody. Off by default, so callers normally send their own. Assigned instructors get their calendar update either way.","uniqueKey":"notifyCustomer","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"clubId":123,"instructorLocationId":123,"areaId":123,"classTypeId":123,"instructorIds":[123],"name":"\u003cstring>","description":"\u003cstring>","priceBeforeTax":1,"isFree":true,"maxCapacity":2,"startTime":"2023-11-07T05:31:56Z","endTime":"2023-11-07T05:31:56Z","sport":"\u003cstring>","color":"\u003cstring>","notifyCustomer":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8a03146e-5542-4679-8d4c-18327017659e":{"description":"Class updated","content":{"application/json":{"schema":{"type":"object","description":"One class occurrence. A weekly class materializes a row per session, linked by `recurrenceId` and `occurrenceIndex`, so `id` is what a booking's `classId` points at - and what distinguishes two groups running in the same hour. Read the staff roster with GET /v1/platform/classes/{id}/bookings.","properties":{"id":{"type":"integer","uniqueKey":"id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"slug":{"oneOf":[{"type":"string","uniqueKey":"slug.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"slug.oneOf.1","typeLabel":"null"}],"uniqueKey":"slug","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"images":{"type":"array","items":{"type":"string","uniqueKey":"images.items.[INDEX]","typeLabel":"string"},"uniqueKey":"images","typeLabel":"string[]"},"classTypeId":{"oneOf":[{"type":"integer","uniqueKey":"classTypeId.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"classTypeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"classTypeId","typeLabel":"integer | null"},"classType":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"classType.oneOf.0.id","typeLabel":"integer"},"name":{"oneOf":[{"type":"string","uniqueKey":"classType.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"classType.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"classType.oneOf.0.name","typeLabel":"string | null"},"slug":{"oneOf":[{"type":"string","uniqueKey":"classType.oneOf.0.slug.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"classType.oneOf.0.slug.oneOf.1","typeLabel":"null"}],"uniqueKey":"classType.oneOf.0.slug","typeLabel":"string | null"},"maxPartySize":{"oneOf":[{"type":"integer","uniqueKey":"classType.oneOf.0.maxPartySize.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"classType.oneOf.0.maxPartySize.oneOf.1","typeLabel":"null"}],"uniqueKey":"classType.oneOf.0.maxPartySize","typeLabel":"integer | null"}},"uniqueKey":"classType.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"integer"},"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"slug":{"oneOf":[{"type":"string"},{"type":"null"}]},"maxPartySize":{"oneOf":[{"type":"integer"},{"type":"null"}]}},"uniqueKey":"classType.oneOf.1","typeLabel":"null"}],"uniqueKey":"classType","typeLabel":"object | null"},"clubId":{"type":"integer","uniqueKey":"clubId","typeLabel":"integer"},"instructorLocationId":{"oneOf":[{"type":"integer","description":"Where the class happens when that is one of its instructors' locations rather than its club: always set for a Professional's class.","uniqueKey":"instructorLocationId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Where the class happens when that is one of its instructors' locations rather than its club: always set for a Professional's class.","uniqueKey":"instructorLocationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructorLocationId","typeLabel":"integer | null"},"club":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"club.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"club.oneOf.0.name","typeLabel":"string"},"slug":{"oneOf":[{"type":"string","uniqueKey":"club.oneOf.0.slug.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"club.oneOf.0.slug.oneOf.1","typeLabel":"null"}],"uniqueKey":"club.oneOf.0.slug","typeLabel":"string | null"}},"uniqueKey":"club.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"integer"},"name":{"type":"string"},"slug":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"club.oneOf.1","typeLabel":"null"}],"uniqueKey":"club","typeLabel":"object | null"},"areaId":{"oneOf":[{"type":"integer","description":"Room or court the class occupies, when one is assigned.","uniqueKey":"areaId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Room or court the class occupies, when one is assigned.","uniqueKey":"areaId.oneOf.1","typeLabel":"null"}],"uniqueKey":"areaId","typeLabel":"integer | null"},"area":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"area.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"area.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"area.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"uniqueKey":"area.oneOf.1","typeLabel":"null"}],"uniqueKey":"area","typeLabel":"object | null"},"startTime":{"type":"string","format":"date-time","uniqueKey":"startTime","typeLabel":"string\u003cdate-time>"},"endTime":{"type":"string","format":"date-time","uniqueKey":"endTime","typeLabel":"string\u003cdate-time>"},"durationMinutes":{"type":"integer","uniqueKey":"durationMinutes","typeLabel":"integer"},"isMultiDay":{"type":"boolean","uniqueKey":"isMultiDay","typeLabel":"boolean"},"status":{"type":"string","enum":["active","cancelled"],"description":"A cancelled occurrence keeps its bookings and roster.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"visibility":{"type":"string","enum":["Public","Member_only","Private"],"uniqueKey":"visibility","typeLabel":"enum\u003cstring>"},"sport":{"oneOf":[{"type":"string","uniqueKey":"sport.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"sport.oneOf.1","typeLabel":"null"}],"uniqueKey":"sport","typeLabel":"string | null"},"color":{"oneOf":[{"type":"string","uniqueKey":"color.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"color.oneOf.1","typeLabel":"null"}],"uniqueKey":"color","typeLabel":"string | null"},"price":{"oneOf":[{"type":"number","format":"float","description":"Price including the organization's default tax - what a member is charged.","uniqueKey":"price.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","description":"Price including the organization's default tax - what a member is charged.","uniqueKey":"price.oneOf.1","typeLabel":"null"}],"uniqueKey":"price","typeLabel":"number\u003cfloat> | null"},"priceBeforeTax":{"oneOf":[{"type":"number","format":"float","description":"The price as stored on the class, before tax.","uniqueKey":"priceBeforeTax.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","description":"The price as stored on the class, before tax.","uniqueKey":"priceBeforeTax.oneOf.1","typeLabel":"null"}],"uniqueKey":"priceBeforeTax","typeLabel":"number\u003cfloat> | null"},"isFree":{"type":"boolean","uniqueKey":"isFree","typeLabel":"boolean"},"maxCapacity":{"oneOf":[{"type":"integer","description":"Seats; null when uncapped.","uniqueKey":"maxCapacity.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seats; null when uncapped.","uniqueKey":"maxCapacity.oneOf.1","typeLabel":"null"}],"uniqueKey":"maxCapacity","typeLabel":"integer | null"},"maxPartySize":{"type":"integer","description":"Largest party one booking may bring, from the class type.","uniqueKey":"maxPartySize","typeLabel":"integer"},"bookedCount":{"type":"integer","description":"Seats taken: attendee bookings plus standalone walk-in check-ins.","uniqueKey":"bookedCount","typeLabel":"integer"},"currentBookings":{"type":"integer","description":"Legacy alias of `bookedCount`.","uniqueKey":"currentBookings","typeLabel":"integer"},"spotsLeft":{"oneOf":[{"type":"integer","description":"`maxCapacity - bookedCount`, floored at 0; null when capacity is unlimited.","uniqueKey":"spotsLeft.oneOf.0","typeLabel":"integer"},{"type":"null","description":"`maxCapacity - bookedCount`, floored at 0; null when capacity is unlimited.","uniqueKey":"spotsLeft.oneOf.1","typeLabel":"null"}],"uniqueKey":"spotsLeft","typeLabel":"integer | null"},"waitlistCount":{"type":"integer","description":"Entries waiting (pending or notified).","uniqueKey":"waitlistCount","typeLabel":"integer"},"allowWaitlist":{"type":"boolean","uniqueKey":"allowWaitlist","typeLabel":"boolean"},"timeStatus":{"type":"string","enum":["past","upcoming"],"uniqueKey":"timeStatus","typeLabel":"enum\u003cstring>"},"availabilityStatus":{"type":"string","enum":["available","full"],"uniqueKey":"availabilityStatus","typeLabel":"enum\u003cstring>"},"recurrenceId":{"oneOf":[{"type":"integer","description":"The series this occurrence belongs to; null for a one-off class.","uniqueKey":"recurrenceId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The series this occurrence belongs to; null for a one-off class.","uniqueKey":"recurrenceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"recurrenceId","typeLabel":"integer | null"},"occurrenceIndex":{"oneOf":[{"type":"integer","description":"Position within the series, as materialized.","uniqueKey":"occurrenceIndex.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Position within the series, as materialized.","uniqueKey":"occurrenceIndex.oneOf.1","typeLabel":"null"}],"uniqueKey":"occurrenceIndex","typeLabel":"integer | null"},"recurrence":{"oneOf":[{"type":"object","description":"The series rule, when this occurrence belongs to one.","properties":{"id":{"type":"integer","uniqueKey":"recurrence.oneOf.0.id","typeLabel":"integer"},"frequency":{"type":"string","enum":["daily","weekly","monthly"],"uniqueKey":"recurrence.oneOf.0.frequency","typeLabel":"enum\u003cstring>"},"interval":{"type":"integer","uniqueKey":"recurrence.oneOf.0.interval","typeLabel":"integer"},"daysOfWeek":{"type":"array","items":{"type":"string","uniqueKey":"recurrence.oneOf.0.daysOfWeek.items.[INDEX]","typeLabel":"string"},"uniqueKey":"recurrence.oneOf.0.daysOfWeek","typeLabel":"string[]"},"endsType":{"type":"string","enum":["until","after","never"],"uniqueKey":"recurrence.oneOf.0.endsType","typeLabel":"enum\u003cstring>"},"endsDate":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"recurrence.oneOf.0.endsDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"recurrence.oneOf.0.endsDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"recurrence.oneOf.0.endsDate","typeLabel":"string\u003cdate-time> | null"},"endsTotalOccurrences":{"oneOf":[{"type":"integer","uniqueKey":"recurrence.oneOf.0.endsTotalOccurrences.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"recurrence.oneOf.0.endsTotalOccurrences.oneOf.1","typeLabel":"null"}],"uniqueKey":"recurrence.oneOf.0.endsTotalOccurrences","typeLabel":"integer | null"},"status":{"type":"string","enum":["active","paused","cancelled"],"uniqueKey":"recurrence.oneOf.0.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"recurrence.oneOf.0","typeLabel":"object"},{"type":"null","description":"The series rule, when this occurrence belongs to one.","properties":{"id":{"type":"integer"},"frequency":{"type":"string","enum":["daily","weekly","monthly"]},"interval":{"type":"integer"},"daysOfWeek":{"type":"array","items":{"type":"string"}},"endsType":{"type":"string","enum":["until","after","never"]},"endsDate":{"oneOf":[{"type":"string","format":"date-time"},{"type":"null","format":"date-time"}]},"endsTotalOccurrences":{"oneOf":[{"type":"integer"},{"type":"null"}]},"status":{"type":"string","enum":["active","paused","cancelled"]}},"uniqueKey":"recurrence.oneOf.1","typeLabel":"null"}],"uniqueKey":"recurrence","typeLabel":"object | null"},"instructors":{"type":"array","description":"Who teaches the occurrence. The instructor's own weekly availability is not included; read it from GET /v1/platform/instructors.","items":{"type":"object","description":"Public instructor shape returned alongside classes.","properties":{"id":{"type":"integer","uniqueKey":"instructors.items.[INDEX].id","typeLabel":"integer"},"contactId":{"type":"integer","uniqueKey":"instructors.items.[INDEX].contactId","typeLabel":"integer"},"sports":{"type":"array","items":{"type":"string","uniqueKey":"instructors.items.[INDEX].sports.items.[INDEX]","typeLabel":"string"},"uniqueKey":"instructors.items.[INDEX].sports","typeLabel":"string[]"},"typeId":{"oneOf":[{"type":"integer","uniqueKey":"instructors.items.[INDEX].typeId.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"instructors.items.[INDEX].typeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructors.items.[INDEX].typeId","typeLabel":"integer | null"},"type":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"instructors.items.[INDEX].type.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"instructors.items.[INDEX].type.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"instructors.items.[INDEX].type.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"integer"},"name":{"type":"string"}},"uniqueKey":"instructors.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructors.items.[INDEX].type","typeLabel":"object | null"},"experience":{"oneOf":[{"type":"string","uniqueKey":"instructors.items.[INDEX].experience.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instructors.items.[INDEX].experience.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructors.items.[INDEX].experience","typeLabel":"string | null"},"hourlyRate":{"oneOf":[{"type":"number","format":"float","uniqueKey":"instructors.items.[INDEX].hourlyRate.oneOf.0","typeLabel":"number\u003cfloat>"},{"type":"null","format":"float","uniqueKey":"instructors.items.[INDEX].hourlyRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructors.items.[INDEX].hourlyRate","typeLabel":"number\u003cfloat> | null"},"bio":{"oneOf":[{"type":"object","additionalProperties":true,"description":"EditorJS document for the instructor bio.","uniqueKey":"instructors.items.[INDEX].bio.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"EditorJS document for the instructor bio.","uniqueKey":"instructors.items.[INDEX].bio.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructors.items.[INDEX].bio","typeLabel":"object | null"},"certifications":{"type":"array","items":{"type":"string","uniqueKey":"instructors.items.[INDEX].certifications.items.[INDEX]","typeLabel":"string"},"uniqueKey":"instructors.items.[INDEX].certifications","typeLabel":"string[]"},"isActive":{"type":"boolean","uniqueKey":"instructors.items.[INDEX].isActive","typeLabel":"boolean"},"isBookable":{"type":"boolean","uniqueKey":"instructors.items.[INDEX].isBookable","typeLabel":"boolean"},"contact":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","uniqueKey":"instructors.items.[INDEX].contact.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instructors.items.[INDEX].contact.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructors.items.[INDEX].contact.oneOf.0.name","typeLabel":"string | null"},"profileImage":{"oneOf":[{"type":"string","uniqueKey":"instructors.items.[INDEX].contact.oneOf.0.profileImage.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instructors.items.[INDEX].contact.oneOf.0.profileImage.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructors.items.[INDEX].contact.oneOf.0.profileImage","typeLabel":"string | null"}},"uniqueKey":"instructors.items.[INDEX].contact.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"profileImage":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"instructors.items.[INDEX].contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructors.items.[INDEX].contact","typeLabel":"object | null"}},"uniqueKey":"instructors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"instructors","typeLabel":"object[]"},"externalSource":{"oneOf":[{"type":"string","description":"Import provenance - set when the occurrence came from an external system rather than being created in 1club.","uniqueKey":"externalSource.oneOf.0","typeLabel":"string"},{"type":"null","description":"Import provenance - set when the occurrence came from an external system rather than being created in 1club.","uniqueKey":"externalSource.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalSource","typeLabel":"string | null"},"externalId":{"oneOf":[{"type":"string","description":"The source system's id for this occurrence, for reconciliation against it.","uniqueKey":"externalId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The source system's id for this occurrence, for reconciliation against it.","uniqueKey":"externalId.oneOf.1","typeLabel":"null"}],"uniqueKey":"externalId","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"translations":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Every locale's copy, keyed by language code (e.g. 'es', 'fr'). Returned alongside the `locale`-resolved `name`/`description`, so an integration syncing a multilingual timetable can read all of them in one call.","uniqueKey":"translations.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Every locale's copy, keyed by language code (e.g. 'es', 'fr'). Returned alongside the `locale`-resolved `name`/`description`, so an integration syncing a multilingual timetable can read all of them in one call.","uniqueKey":"translations.oneOf.1","typeLabel":"null"}],"uniqueKey":"translations","typeLabel":"object | null"},"series":{"type":"object","description":"Present **only** on the response to a recurring create or to an update that moved where the series ends, never on a read: it describes what that one request did. An occurrence at a club that is closed, or past its closing date, is skipped rather than failing the request, so comparing `occurrencesCreated` with what you asked for is the only way a partially-skipped season is visible.","properties":{"recurrenceId":{"type":"integer","uniqueKey":"series.recurrenceId","typeLabel":"integer"},"occurrencesCreated":{"type":"integer","description":"Occurrences written by this request. The whole series for a bounded one; the first window for an open-ended one, which the extension job grows from there.","uniqueKey":"series.occurrencesCreated","typeLabel":"integer"},"occurrencesRemoved":{"type":"integer","description":"Occurrences past the new end that this request removed. Only on the response to an end change.","uniqueKey":"series.occurrencesRemoved","typeLabel":"integer"}},"uniqueKey":"series","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"name":"\u003cstring>","slug":"\u003cstring>","description":"\u003cstring>","images":["\u003cstring>"],"classTypeId":123,"classType":{"id":123,"name":"\u003cstring>","slug":"\u003cstring>","maxPartySize":123},"clubId":123,"instructorLocationId":123,"club":{"id":123,"name":"\u003cstring>","slug":"\u003cstring>"},"areaId":123,"area":{"id":123,"name":"\u003cstring>"},"startTime":"2023-11-07T05:31:56Z","endTime":"2023-11-07T05:31:56Z","durationMinutes":123,"isMultiDay":true,"status":"active","visibility":"Public","sport":"\u003cstring>","color":"\u003cstring>","price":123,"priceBeforeTax":123,"isFree":true,"maxCapacity":123,"maxPartySize":123,"bookedCount":123,"currentBookings":123,"spotsLeft":123,"waitlistCount":123,"allowWaitlist":true,"timeStatus":"past","availabilityStatus":"available","recurrenceId":123,"occurrenceIndex":123,"recurrence":{"id":123,"frequency":"daily","interval":123,"daysOfWeek":["\u003cstring>"],"endsType":"until","endsDate":"2023-11-07T05:31:56Z","endsTotalOccurrences":123,"status":"active"},"instructors":[{"id":123,"contactId":123,"sports":["\u003cstring>"],"typeId":123,"type":{"id":123,"name":"\u003cstring>"},"experience":"\u003cstring>","hourlyRate":123,"bio":{},"certifications":["\u003cstring>"],"isActive":true,"isBookable":true,"contact":{"name":"\u003cstring>","profileImage":"\u003cstring>"}}],"externalSource":"\u003cstring>","externalId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","translations":{},"series":{"recurrenceId":123,"occurrencesCreated":123,"occurrencesRemoved":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"9bf23cd2-a785-4736-89bb-9905a43f14ad":{"description":"Invalid request (bad parameters, or a body that fails validation)","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"},"8ed3f12a-acee-42e4-ac79-b414a4fb6501":{"description":"Missing `classes:write` scope","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"0305a220-571e-4f6b-9893-3c68b2dc5abf":{"description":"The requested resource does not exist in this organization","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"},"98157989-7674-4c57-b8c7-b3a67fd064e6":{"description":"The new time double-books the area, or an occurrence a new series end would remove has active bookings or waitlist entries","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"6cafe0ae-d048-403e-b9e1-09763efc2236":{"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 a class - 1club Help","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T14:43:53.113Z","originalFileLocation":"api-reference/classes/update-a-class.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=\"Updates one occurrence, or this and all future occurrences when scope=all_future. A recurring class defaults to this_instance, so a series-wide edit must ask for it explicitly. With scope=all_future, recurrence moves where the series ends - ends plus endDate, the same fields a create takes. Send it on its own: a body that also carries class fields is refused, so an end change never half-applies. Only the end: a frequency, interval or daysOfWeek is refused, and to change a cadence you delete the remaining series and create it again. A later end writes the new occurrences; an earlier one removes the occurrences past it, and is refused with 409 when any of those has an active booking or waitlist entry (cancel them first) - nothing a member holds is cancelled as a side effect. The occurrence named must be one the series keeps, and the end cannot fall before a session that has already run. The response to an end change carries series.occurrencesCreated and series.occurrencesRemoved. As on a create, an occurrence at a club that is closed is skipped rather than failing the request, so compare the count with what you expected.\">\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 a class - 1club Help\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates one occurrence, or this and all future occurrences when scope=all_future. A recurring class defaults to this_instance, so a series-wide edit must ask for it explicitly. With scope=all_future, recurrence moves where the series ends - ends plus endDate, the same fields a create takes. Send it on its own: a body that also carries class fields is refused, so an end change never half-applies. Only the end: a frequency, interval or daysOfWeek is refused, and to change a cadence you delete the remaining series and create it again. A later end writes the new occurrences; an earlier one removes the occurrences past it, and is refused with 409 when any of those has an active booking or waitlist entry (cancel them first) - nothing a member holds is cancelled as a side effect. The occurrence named must be one the series keeps, and the end cannot fall before a session that has already run. The response to an end change carries series.occurrencesCreated and series.occurrencesRemoved. As on a create, an occurrence at a club that is closed is skipped rather than failing the request, so compare the count with what you expected.\">\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/classes/update-a-class\">\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=Classes\u0026amp;title=Update+a+class\u0026amp;description=Updates+one+occurrence%2C+or+this+and+all+future+occurrences+when+%60scope%3Dall_future%60.+A+recurring+class+defaults+to+%60this_instance%60%2C+so+a+series-wide+edit+must+as\u0026amp;theme=ed3cd824c84f0d7b56c4d20a\u0026amp;signature=3728b7b9d8b5adb313f9a283751ea4113904a141136c2ad9ed929b81c9b1e795\">\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 a class - 1club Help\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates one occurrence, or this and all future occurrences when scope=all_future. A recurring class defaults to this_instance, so a series-wide edit must ask for it explicitly. With scope=all_future, recurrence moves where the series ends - ends plus endDate, the same fields a create takes. Send it on its own: a body that also carries class fields is refused, so an end change never half-applies. Only the end: a frequency, interval or daysOfWeek is refused, and to change a cadence you delete the remaining series and create it again. A later end writes the new occurrences; an earlier one removes the occurrences past it, and is refused with 409 when any of those has an active booking or waitlist entry (cancel them first) - nothing a member holds is cancelled as a side effect. The occurrence named must be one the series keeps, and the end cannot fall before a session that has already run. The response to an end change carries series.occurrencesCreated and series.occurrencesRemoved. As on a create, an occurrence at a club that is closed is skipped rather than failing the request, so compare the count with what you expected.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://1club.mintlify.site/_mintlify/api/og/v2?division=Classes\u0026amp;title=Update+a+class\u0026amp;description=Updates+one+occurrence%2C+or+this+and+all+future+occurrences+when+%60scope%3Dall_future%60.+A+recurring+class+defaults+to+%60this_instance%60%2C+so+a+series-wide+edit+must+as\u0026amp;theme=ed3cd824c84f0d7b56c4d20a\u0026amp;signature=3728b7b9d8b5adb313f9a283751ea4113904a141136c2ad9ed929b81c9b1e795\">\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/classes/update-a-class\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/classes/update-a-class.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/classes/update-a-class#webpage\",\"url\":\"https://docs.1club.ai/api-reference/classes/update-a-class\",\"name\":\"Update a class\",\"description\":\"Updates one occurrence, or this and all future occurrences when scope=all_future. A recurring class defaults to this_instance, so a series-wide edit must ask for it explicitly. With scope=all_future, recurrence moves where the series ends - ends plus endDate, the same fields a create takes. Send it on its own: a body that also carries class fields is refused, so an end change never half-applies. Only the end: a frequency, interval or daysOfWeek is refused, and to change a cadence you delete the remaining series and create it again. A later end writes the new occurrences; an earlier one removes the occurrences past it, and is refused with 409 when any of those has an active booking or waitlist entry (cancel them first) - nothing a member holds is cancelled as a side effect. The occurrence named must be one the series keeps, and the end cannot fall before a session that has already run. The response to an end change carries series.occurrencesCreated and series.occurrencesRemoved. As on a create, an occurrence at a club that is closed is skipped rather than failing the request, so compare the count with what you expected.\",\"dateModified\":\"2026-11-20T14:43:53.113Z\",\"isPartOf\":{\"@id\":\"https://docs.1club.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.1club.ai/api-reference/classes/update-a-class#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.1club.ai/api-reference/classes/update-a-class#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Classes\",\"item\":\"https://docs.1club.ai/api-reference/classes/list-class-types\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a class\",\"item\":\"https://docs.1club.ai/api-reference/classes/update-a-class\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.1club.ai/api-reference/classes/update-a-class#apireference\",\"headline\":\"Update a class\",\"name\":\"Update a class\",\"description\":\"Updates one occurrence, or this and all future occurrences when scope=all_future. A recurring class defaults to this_instance, so a series-wide edit must ask for it explicitly. With scope=all_future, recurrence moves where the series ends - ends plus endDate, the same fields a create takes. Send it on its own: a body that also carries class fields is refused, so an end change never half-applies. Only the end: a frequency, interval or daysOfWeek is refused, and to change a cadence you delete the remaining series and create it again. A later end writes the new occurrences; an earlier one removes the occurrences past it, and is refused with 409 when any of those has an active booking or waitlist entry (cancel them first) - nothing a member holds is cancelled as a side effect. The occurrence named must be one the series keeps, and the end cannot fall before a session that has already run. The response to an end change carries series.occurrencesCreated and series.occurrencesRemoved. As on a create, an occurrence at a club that is closed is skipped rather than failing the request, so compare the count with what you expected.\",\"url\":\"https://docs.1club.ai/api-reference/classes/update-a-class\",\"mainEntityOfPage\":{\"@id\":\"https://docs.1club.ai/api-reference/classes/update-a-class#webpage\"},\"dateModified\":\"2026-11-20T14:43:53.113Z\",\"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/classes/update-a-class.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","description":"Deletes one occurrence, or this and all future occurrences when `scope=all_future`.","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","description":"Returns the organization's programs - what a student joins, such as \"Kids BJJ (7-12)\" or \"Adult BJJ\". A program groups class types, and the sessions of its class types count toward its progression track. Resolve one here to fill in `programId` on a class type. There is no paging: an organization has a handful of these. Listed in their display order.\n","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","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","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 a class - 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"]}