Edits a booking by its 1club id: reschedule it, move it to another area, attach or remove an instructor, reassign the contact, change its notes or price, or make it recur. Send only the fields that change. Reaches the same bookings as cancel: an API key only those it created, a staff member through an authorized 1club assistant any of the organization’s.
The edit follows the admin portal’s rules. A cancelled booking is final, and a booking on a class takes its time and price from the class. As on create, the club’s member-facing policy (operating hours, instructor availability) is not applied, but an occupied or blocked court, or a coach who is already booked, is refused with details.conflicts[].
Money follows the edit. amount reprices the booking to your figure. Without it, a booking this API created keeps its price, and a booking taken through 1club is re-quoted when the slot, area, instructor or contact changes. The charge is then reconciled: an increase on a paid booking leaves the difference outstanding, and a decrease below what was paid needs a refund, which this endpoint does not perform. Payment status cannot be changed here.
Recurring bookings. recurrence on a one-off booking makes it the first occurrence of a series. On an occurrence of a series, scope=all_future applies the edit to this occurrence and every later one that has not started yet (earlier dates keep what they have): a new startTime/endTime gives each that time of day on its own date (the weekday changes only through recurrence.daysOfWeek), a new area or instructor is checked against every date, and a new recurrence rewrites the cadence or end condition; days dropped from a weekly pattern are cancelled with their refund. A series bound to a recurring class follows the class and cannot be re-timed, and a booking an API key created cannot be made to recur at all (RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY): 1club would be generating occurrences that key never created, so each one is its own booking. An edit whose series has already run touches nothing.
Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.
Headers
Idempotency-Key
string
Retry-safe key; a repeat of the same request replays the first response
Maximum string length: 255
Path Parameters
id
integer
required
1club booking id
Query Parameters
scope
enum<string>
default:this_instance
For an occurrence of a recurring booking, whether the edit applies to it alone or to it and every later not-yet-started occurrence of the series (see the description)
Available options:
this_instance,
all_future
Body
application/json
An edit to a booking. Every field is optional; send only what changes. A body with nothing but notifyCustomer is refused.
startTime
string<date-time>
New start. With scope=all_future, every later occurrence takes this time of day on its own date; change the weekday with recurrence.daysOfWeek.
endTime
string<date-time>
New end. Must be after the start, stored or sent.
areaId
integer
Move the booking to this area (from GET /v1/platform/areas). Must be an area this API can sell, as on create.
instructorId
integer | null
Attach this instructor to the session (from GET /v1/platform/instructors), or null to take the instructor off it. Must be free at the time.
contactId
integer
Reassign the booking to this contact (from GET /v1/platform/contacts). The outstanding charge, if any, moves with it.
notes
string
Maximum string length: 2000
amount
number
The booking's new price, before tax, in the club's currency - your own figure, kept as sent. Omit it to keep the price you recorded on a booking this API created, or to have a booking taken through 1club re-quoted by the club's pricing engine when the slot, area, instructor or contact changes. Cannot be set on a booking a membership covers.
Required range: x <= 1000000
recurrence
object
Make a one-off booking recur, or (with scope=all_future) rewrite the cadence or end condition of an existing series. The series starts at the booking's own start time, so there is no start date here. daysOfWeek is required for a weekly pattern, and a day repeated in it counts once. Not accepted on a booking an API key created.
Show child attributes
notifyCustomer
boolean
Tell the customer their booking changed - email with the updated calendar invite plus the in-app and WhatsApp notification. Only sent when the edit names a time, area, instructor or class. Off by default for an API key, on by default over an OAuth connection, as on create.
Response
The booking after the edit - for a series edit, the occurrence you named
A booking created through the platform API. Recorded with a booking transaction so it counts for revenue, marked paid (settled against a payment method named after the caller's API key, so the club can reconcile what each partner collected) or unpaid (outstanding) per the caller. Collection stays with the caller; what it collected and what it gave back on cancellation are reported in payment.
bookingId
integer
1club booking id
bookingUuid
string<uuid>
Stable unguessable identifier. Prefer this over bookingId when storing a reference.
status
string
Booking status (e.g. confirmed, cancelled)
areaId
integer | null
Area id
classId
integer | null
The class occurrence this booking attends, when it is a class booking. Every attendee holds their own booking row against the same classId, and classes rows are per-occurrence - so this is what tells two classes running in the same hour apart. Join it against GET /v1/platform/classes, or read the staff roster with GET /v1/platform/classes/{id}/bookings.
eventId
integer | null
The event this booking attends, when it is an event booking. Read the attendee list with GET /v1/platform/events/{id}/bookings.
eventTicketId
integer | null
The event ticket the seat was sold on, when the event sells tickets
orderId
integer | null
The order the booking was sold on: one per sale, holding the customer's seat and any guests'. Every class enrolment and event registration made through this API has one; null for a booking sold on none (a court or coach booked through POST /v1/platform/bookings).
seatBookingIds
integer[]
Every seat the sale holds, the customer's own first. Only on the answer to a seat sale (POST /v1/platform/classes/{id}/bookings, POST /v1/platform/events/{id}/bookings); the guests' seats carry no contact, and the class's or the event's roster lists them all.
maxPlayers
integer | null
How many players the booking takes, the organizer included, when it differs from the area type's defaultMaxPlayers: 2 on a court booked for singles (area types with allowsSingles). null means the area type's own limit. Adding a player past it is refused.
instructorId
integer | null
Instructor leading the session, when one is attached
contactId
integer | null
Contact the booking is for
startTime
string<date-time>
endTime
string<date-time>
customer
object | null
The booking's customer, identical to what GET /v1/platform/contacts/{id} returns. Present only when the request passes include=customer, which additionally requires the contacts:read scope; null when the booking has no contact. Use it to import a window of bookings without a contact lookup per row.
Show child attributes
money
object
What the booking costs and how it was paid. Present only with include=money, which additionally requires the transactions:read scope. billed is always paid + outstanding, on the same basis as the admin's Booking audit: tax-inclusive, net of refunds, so a cancelled booking bills only the Cancellation Charge it kept.
Show child attributes
cancellation
object
The cancellation terms stamped on the booking and how it was cancelled. Present only with include=cancellation.
Show child attributes
payment
object
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/bookings/update-a-booking","slug":"/api-reference/bookings/update-a-booking","pageMetadata":{"title":"Update a booking","description":"Edits a booking by its 1club id: reschedule it, move it to another area, attach or remove an instructor, reassign the contact, change its notes or price, or make it recur. Send only the fields that change. Reaches the same bookings as cancel: an API key only those it created, a staff member through an authorized 1club assistant any of the organization's.\n\nThe edit follows the admin portal's rules. A cancelled booking is final, and a booking on a class takes its time and price from the class. As on create, the club's member-facing policy (operating hours, instructor availability) is not applied, but an occupied or blocked court, or a coach who is already booked, is refused with `details.conflicts[]`.\n\nMoney follows the edit. `amount` reprices the booking to your figure. Without it, a booking this API created keeps its price, and a booking taken through 1club is re-quoted when the slot, area, instructor or contact changes. The charge is then reconciled: an increase on a paid booking leaves the difference outstanding, and a decrease below what was paid needs a refund, which this endpoint does not perform. Payment status cannot be changed here.\n\nRecurring bookings. `recurrence` on a one-off booking makes it the first occurrence of a series. On an occurrence of a series, `scope=all_future` applies the edit to this occurrence and every later one that has not started yet (earlier dates keep what they have): a new `startTime`/`endTime` gives each that time of day on its own date (the weekday changes only through `recurrence.daysOfWeek`), a new area or instructor is checked against every date, and a new `recurrence` rewrites the cadence or end condition; days dropped from a weekly pattern are cancelled with their refund. A series bound to a recurring class follows the class and cannot be re-timed, and a booking an API key created cannot be made to recur at all (`RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY`): 1club would be generating occurrences that key never created, so each one is its own booking. An edit whose series has already run touches nothing.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/bookings/{id}","href":"/api-reference/bookings/update-a-booking","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: [_jsx(_components.p, {\n children: \"Edits a booking by its 1club id: reschedule it, move it to another area, attach or remove an instructor, reassign the contact, change its notes or price, or make it recur. Send only the fields that change. Reaches the same bookings as cancel: an API key only those it created, a staff member through an authorized 1club assistant any of the organization’s.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The edit follows the admin portal’s rules. A cancelled booking is final, and a booking on a class takes its time and price from the class. As on create, the club’s member-facing policy (operating hours, instructor availability) is not applied, but an occupied or blocked court, or a coach who is already booked, is refused with \", _jsx(_components.code, {\n children: \"details.conflicts[]\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Money follows the edit. \", _jsx(_components.code, {\n children: \"amount\"\n }), \" reprices the booking to your figure. Without it, a booking this API created keeps its price, and a booking taken through 1club is re-quoted when the slot, area, instructor or contact changes. The charge is then reconciled: an increase on a paid booking leaves the difference outstanding, and a decrease below what was paid needs a refund, which this endpoint does not perform. Payment status cannot be changed here.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Recurring bookings. \", _jsx(_components.code, {\n children: \"recurrence\"\n }), \" on a one-off booking makes it the first occurrence of a series. On an occurrence of a series, \", _jsx(_components.code, {\n children: \"scope=all_future\"\n }), \" applies the edit to this occurrence and every later one that has not started yet (earlier dates keep what they have): a new \", _jsx(_components.code, {\n children: \"startTime\"\n }), \"/\", _jsx(_components.code, {\n children: \"endTime\"\n }), \" gives each that time of day on its own date (the weekday changes only through \", _jsx(_components.code, {\n children: \"recurrence.daysOfWeek\"\n }), \"), a new area or instructor is checked against every date, and a new \", _jsx(_components.code, {\n children: \"recurrence\"\n }), \" rewrites the cadence or end condition; days dropped from a weekly pattern are cancelled with their refund. A series bound to a recurring class follows the class and cannot be re-timed, and a booking an API key created cannot be made to recur at all (\", _jsx(_components.code, {\n children: \"RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY\"\n }), \"): 1club would be generating occurrences that key never created, so each one is its own booking. An edit whose series has already run touches nothing.\"]\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 booking","description":"Edits a booking by its 1club id: reschedule it, move it to another area, attach or remove an instructor, reassign the contact, change its notes or price, or make it recur. Send only the fields that change. Reaches the same bookings as cancel: an API key only those it created, a staff member through an authorized 1club assistant any of the organization's.\n\nThe edit follows the admin portal's rules. A cancelled booking is final, and a booking on a class takes its time and price from the class. As on create, the club's member-facing policy (operating hours, instructor availability) is not applied, but an occupied or blocked court, or a coach who is already booked, is refused with `details.conflicts[]`.\n\nMoney follows the edit. `amount` reprices the booking to your figure. Without it, a booking this API created keeps its price, and a booking taken through 1club is re-quoted when the slot, area, instructor or contact changes. The charge is then reconciled: an increase on a paid booking leaves the difference outstanding, and a decrease below what was paid needs a refund, which this endpoint does not perform. Payment status cannot be changed here.\n\nRecurring bookings. `recurrence` on a one-off booking makes it the first occurrence of a series. On an occurrence of a series, `scope=all_future` applies the edit to this occurrence and every later one that has not started yet (earlier dates keep what they have): a new `startTime`/`endTime` gives each that time of day on its own date (the weekday changes only through `recurrence.daysOfWeek`), a new area or instructor is checked against every date, and a new `recurrence` rewrites the cadence or end condition; days dropped from a weekly pattern are cancelled with their refund. A series bound to a recurring class follows the class and cannot be re-timed, and a booking an API key created cannot be made to recur at all (`RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY`): 1club would be generating occurrences that key never created, so each one is its own booking. An edit whose series has already run touches nothing.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/bookings/{id}","href":"/api-reference/bookings/update-a-booking","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateBooking","summary":"Update a booking","description":"Edits a booking by its 1club id: reschedule it, move it to another area, attach or remove an instructor, reassign the contact, change its notes or price, or make it recur. Send only the fields that change. Reaches the same bookings as cancel: an API key only those it created, a staff member through an authorized 1club assistant any of the organization's.\n\nThe edit follows the admin portal's rules. A cancelled booking is final, and a booking on a class takes its time and price from the class. As on create, the club's member-facing policy (operating hours, instructor availability) is not applied, but an occupied or blocked court, or a coach who is already booked, is refused with `details.conflicts[]`.\n\nMoney follows the edit. `amount` reprices the booking to your figure. Without it, a booking this API created keeps its price, and a booking taken through 1club is re-quoted when the slot, area, instructor or contact changes. The charge is then reconciled: an increase on a paid booking leaves the difference outstanding, and a decrease below what was paid needs a refund, which this endpoint does not perform. Payment status cannot be changed here.\n\nRecurring bookings. `recurrence` on a one-off booking makes it the first occurrence of a series. On an occurrence of a series, `scope=all_future` applies the edit to this occurrence and every later one that has not started yet (earlier dates keep what they have): a new `startTime`/`endTime` gives each that time of day on its own date (the weekday changes only through `recurrence.daysOfWeek`), a new area or instructor is checked against every date, and a new `recurrence` rewrites the cadence or end condition; days dropped from a weekly pattern are cancelled with their refund. A series bound to a recurring class follows the class and cannot be re-timed, and a booking an API key created cannot be made to recur at all (`RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY`): 1club would be generating occurrences that key never created, so each one is its own booking. An edit whose series has already run touches nothing.\n","tags":["Bookings"],"security":["85132dc8-04d6-4a8b-94f9-3a94819bd586"],"parameters":["8a28151d-818c-4224-889f-4417d17fdd68","c78b1023-3b9d-4bfb-9185-3e7c3ee8c510","925080d0-fc20-48c8-954a-929aaed72ddb"],"requestBody":"95379f3b-0347-4719-bbb7-167ff247b849","responses":{"200":"f1b735cd-2d24-487f-8635-e8f1f18f5135","400":"ce86b189-b55b-4ad1-87f9-c2d36bc52641","401":"bba66a98-d1c6-4d87-95a7-10675006789c","403":"9f016f73-3b94-4cd7-986a-d3d10c662444","404":"94e5f210-0a10-4e7b-9b05-495bf3d15775","409":"ab5b4072-aa81-4f9f-853e-eeca1629c68a","429":"d91705a1-769a-4246-ab54-be300697632e"},"method":"patch","type":"path","servers":["271bc9cb-062d-498d-90b7-92302d2b0c58"],"path":"/v1/platform/bookings/{id}","baseUrlOptions":["https://api.1club.ai"],"title":"Update a booking","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8a28151d-818c-4224-889f-4417d17fdd68":{"in":"path","name":"id","required":true,"schema":{"type":"integer","isRequired":true,"description":"1club booking id","uniqueKey":"","typeLabel":"integer"},"description":"1club booking id"},"c78b1023-3b9d-4bfb-9185-3e7c3ee8c510":{"in":"query","name":"scope","schema":{"type":"string","enum":["this_instance","all_future"],"default":"this_instance","description":"For an occurrence of a recurring booking, whether the edit applies to it alone or to it and every later not-yet-started occurrence of the series (see the description)","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"For an occurrence of a recurring booking, whether the edit applies to it alone or to it and every later not-yet-started occurrence of the series (see the description)"},"925080d0-fc20-48c8-954a-929aaed72ddb":{"in":"header","name":"Idempotency-Key","schema":{"type":"string","maxLength":255,"description":"Retry-safe key; a repeat of the same request replays the first response","uniqueKey":"","typeLabel":"string"},"description":"Retry-safe key; a repeat of the same request replays the first response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"An edit to a booking. Every field is optional; send only what changes. A body with nothing but `notifyCustomer` is refused.","properties":{"startTime":{"type":"string","format":"date-time","description":"New start. With `scope=all_future`, every later occurrence takes this time of day on its own date; change the weekday with `recurrence.daysOfWeek`.","uniqueKey":"startTime","typeLabel":"string\u003cdate-time>"},"endTime":{"type":"string","format":"date-time","description":"New end. Must be after the start, stored or sent.","uniqueKey":"endTime","typeLabel":"string\u003cdate-time>"},"areaId":{"type":"integer","description":"Move the booking to this area (from GET /v1/platform/areas). Must be an area this API can sell, as on create.","uniqueKey":"areaId","typeLabel":"integer"},"instructorId":{"oneOf":[{"type":"integer","description":"Attach this instructor to the session (from GET /v1/platform/instructors), or `null` to take the instructor off it. Must be free at the time.","uniqueKey":"instructorId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Attach this instructor to the session (from GET /v1/platform/instructors), or `null` to take the instructor off it. Must be free at the time.","uniqueKey":"instructorId.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructorId","typeLabel":"integer | null"},"contactId":{"type":"integer","description":"Reassign the booking to this contact (from GET /v1/platform/contacts). The outstanding charge, if any, moves with it.","uniqueKey":"contactId","typeLabel":"integer"},"notes":{"type":"string","maxLength":2000,"uniqueKey":"notes","typeLabel":"string"},"amount":{"type":"number","maximum":1000000,"description":"The booking's new price, before tax, in the club's currency - your own figure, kept as sent. Omit it to keep the price you recorded on a booking this API created, or to have a booking taken through 1club re-quoted by the club's pricing engine when the slot, area, instructor or contact changes. Cannot be set on a booking a membership covers.","uniqueKey":"amount","typeLabel":"number"},"recurrence":{"type":"object","description":"Make a one-off booking recur, or (with `scope=all_future`) rewrite the cadence or end condition of an existing series. The series starts at the booking's own start time, so there is no start date here. `daysOfWeek` is required for a weekly pattern, and a day repeated in it counts once. Not accepted on a booking an API key created.","required":["frequency","interval"],"properties":{"frequency":{"type":"string","enum":["daily","weekly","monthly"],"isRequired":true,"uniqueKey":"recurrence.frequency","typeLabel":"enum\u003cstring>"},"interval":{"type":"integer","minimum":1,"description":"Every N days / weeks / months","isRequired":true,"uniqueKey":"recurrence.interval","typeLabel":"integer"},"daysOfWeek":{"type":"array","items":{"type":"string","enum":["sunday","monday","tuesday","wednesday","thursday","friday","saturday"],"uniqueKey":"recurrence.daysOfWeek.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"For a weekly pattern, the days it runs on","uniqueKey":"recurrence.daysOfWeek","typeLabel":"enum\u003cstring>[]"},"endDate":{"type":"string","format":"date-time","description":"Last date of the series, with `ends.type: until`","uniqueKey":"recurrence.endDate","typeLabel":"string\u003cdate-time>"},"ends":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["until","after","never"],"description":"`until` runs to `endDate`, `after` runs for `occurrences` sessions, `never` extends on a rolling window","isRequired":true,"uniqueKey":"recurrence.ends.type","typeLabel":"enum\u003cstring>"},"occurrences":{"type":"integer","minimum":1,"maximum":520,"description":"With `after`: how many sessions the series holds, counted from its start","uniqueKey":"recurrence.ends.occurrences","typeLabel":"integer"}},"uniqueKey":"recurrence.ends","typeLabel":"object"}},"uniqueKey":"recurrence","typeLabel":"object"},"notifyCustomer":{"type":"boolean","description":"Tell the customer their booking changed - email with the updated calendar invite plus the in-app and WhatsApp notification. Only sent when the edit names a time, area, instructor or class. Off by default for an API key, on by default over an OAuth connection, as on create.","uniqueKey":"notifyCustomer","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"startTime":"2023-11-07T05:31:56Z","endTime":"2023-11-07T05:31:56Z","areaId":123,"instructorId":123,"contactId":123,"notes":"\u003cstring>","amount":123,"notifyCustomer":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f1b735cd-2d24-487f-8635-e8f1f18f5135":{"description":"The booking after the edit - for a series edit, the occurrence you named","content":{"application/json":{"schema":{"type":"object","description":"A booking created through the platform API. Recorded with a booking transaction so it counts for revenue, marked paid (settled against a payment method named after the caller's API key, so the club can reconcile what each partner collected) or unpaid (outstanding) per the caller. Collection stays with the caller; what it collected and what it gave back on cancellation are reported in `payment`.","properties":{"bookingId":{"type":"integer","description":"1club booking id","uniqueKey":"bookingId","typeLabel":"integer"},"bookingUuid":{"type":"string","format":"uuid","description":"Stable unguessable identifier. Prefer this over `bookingId` when storing a reference.","uniqueKey":"bookingUuid","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Booking status (e.g. confirmed, cancelled)","uniqueKey":"status","typeLabel":"string"},"areaId":{"oneOf":[{"type":"integer","description":"Area id","uniqueKey":"areaId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Area id","uniqueKey":"areaId.oneOf.1","typeLabel":"null"}],"uniqueKey":"areaId","typeLabel":"integer | null"},"classId":{"oneOf":[{"type":"integer","description":"The class occurrence this booking attends, when it is a class booking. Every attendee holds their own booking row against the same `classId`, and `classes` rows are per-occurrence - so this is what tells two classes running in the same hour apart. Join it against GET /v1/platform/classes, or read the staff roster with GET /v1/platform/classes/{id}/bookings.","uniqueKey":"classId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The class occurrence this booking attends, when it is a class booking. Every attendee holds their own booking row against the same `classId`, and `classes` rows are per-occurrence - so this is what tells two classes running in the same hour apart. Join it against GET /v1/platform/classes, or read the staff roster with GET /v1/platform/classes/{id}/bookings.","uniqueKey":"classId.oneOf.1","typeLabel":"null"}],"uniqueKey":"classId","typeLabel":"integer | null"},"eventId":{"oneOf":[{"type":"integer","description":"The event this booking attends, when it is an event booking. Read the attendee list with GET /v1/platform/events/{id}/bookings.","uniqueKey":"eventId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The event this booking attends, when it is an event booking. Read the attendee list with GET /v1/platform/events/{id}/bookings.","uniqueKey":"eventId.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventId","typeLabel":"integer | null"},"eventTicketId":{"oneOf":[{"type":"integer","description":"The event ticket the seat was sold on, when the event sells tickets","uniqueKey":"eventTicketId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The event ticket the seat was sold on, when the event sells tickets","uniqueKey":"eventTicketId.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventTicketId","typeLabel":"integer | null"},"orderId":{"oneOf":[{"type":"integer","description":"The order the booking was sold on: one per sale, holding the customer's seat and any guests'. Every class enrolment and event registration made through this API has one; null for a booking sold on none (a court or coach booked through POST /v1/platform/bookings).","uniqueKey":"orderId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The order the booking was sold on: one per sale, holding the customer's seat and any guests'. Every class enrolment and event registration made through this API has one; null for a booking sold on none (a court or coach booked through POST /v1/platform/bookings).","uniqueKey":"orderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"orderId","typeLabel":"integer | null"},"seatBookingIds":{"type":"array","items":{"type":"integer","uniqueKey":"seatBookingIds.items.[INDEX]","typeLabel":"integer"},"description":"Every seat the sale holds, the customer's own first. Only on the answer to a seat sale (POST /v1/platform/classes/{id}/bookings, POST /v1/platform/events/{id}/bookings); the guests' seats carry no contact, and the class's or the event's roster lists them all.","uniqueKey":"seatBookingIds","typeLabel":"integer[]"},"maxPlayers":{"oneOf":[{"type":"integer","description":"How many players the booking takes, the organizer included, when it differs from the area type's `defaultMaxPlayers`: `2` on a court booked for singles (area types with `allowsSingles`). `null` means the area type's own limit. Adding a player past it is refused.","uniqueKey":"maxPlayers.oneOf.0","typeLabel":"integer"},{"type":"null","description":"How many players the booking takes, the organizer included, when it differs from the area type's `defaultMaxPlayers`: `2` on a court booked for singles (area types with `allowsSingles`). `null` means the area type's own limit. Adding a player past it is refused.","uniqueKey":"maxPlayers.oneOf.1","typeLabel":"null"}],"uniqueKey":"maxPlayers","typeLabel":"integer | null"},"instructorId":{"oneOf":[{"type":"integer","description":"Instructor leading the session, when one is attached","uniqueKey":"instructorId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Instructor leading the session, when one is attached","uniqueKey":"instructorId.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructorId","typeLabel":"integer | null"},"contactId":{"oneOf":[{"type":"integer","description":"Contact the booking is for","uniqueKey":"contactId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Contact the booking is for","uniqueKey":"contactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"contactId","typeLabel":"integer | 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>"},"customer":{"oneOf":[{"type":"object","description":"The booking's customer, identical to what GET /v1/platform/contacts/{id} returns. Present only when the request passes `include=customer`, which additionally requires the `contacts:read` scope; `null` when the booking has no contact. Use it to import a window of bookings without a contact lookup per row.","properties":{"id":{"type":"integer","uniqueKey":"customer.oneOf.0.id","typeLabel":"integer"},"uuid":{"type":"string","format":"uuid","description":"Stable unguessable identifier. Prefer this over `id` when storing a reference.","uniqueKey":"customer.oneOf.0.uuid","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"customer.oneOf.0.name","typeLabel":"string"},"firstName":{"type":"string","uniqueKey":"customer.oneOf.0.firstName","typeLabel":"string"},"lastName":{"oneOf":[{"type":"string","uniqueKey":"customer.oneOf.0.lastName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.oneOf.0.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.lastName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"customer.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"customer.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"customer.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.phone","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"Derived contact type (e.g. contact, member, lead). `archived` marks a retired contact — hidden from the list and from search, but still readable by id.","uniqueKey":"customer.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Derived contact type (e.g. contact, member, lead). `archived` marks a retired contact — hidden from the list and from search, but still readable by id.","uniqueKey":"customer.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.type","typeLabel":"string | null"},"pipelineStageId":{"oneOf":[{"type":"integer","description":"The sales pipeline stage the contact is in, or null when they are not in the pipeline.","uniqueKey":"customer.oneOf.0.pipelineStageId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The sales pipeline stage the contact is in, or null when they are not in the pipeline.","uniqueKey":"customer.oneOf.0.pipelineStageId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.pipelineStageId","typeLabel":"integer | null"},"pipelineLostReason":{"oneOf":[{"type":"string","enum":["price","timing","chose_competitor","location","no_response","not_interested","not_a_fit","other"],"description":"Why the lead was lost, while they are in the Lost stage. Null outside it, or when no reason was given.","uniqueKey":"customer.oneOf.0.pipelineLostReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["price","timing","chose_competitor","location","no_response","not_interested","not_a_fit","other"],"description":"Why the lead was lost, while they are in the Lost stage. Null outside it, or when no reason was given.","uniqueKey":"customer.oneOf.0.pipelineLostReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.pipelineLostReason","typeLabel":"enum\u003cstring> | null"},"pipelineLostNote":{"oneOf":[{"type":"string","description":"The note given with the lost reason.","uniqueKey":"customer.oneOf.0.pipelineLostNote.oneOf.0","typeLabel":"string"},{"type":"null","description":"The note given with the lost reason.","uniqueKey":"customer.oneOf.0.pipelineLostNote.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.pipelineLostNote","typeLabel":"string | null"},"sourceId":{"oneOf":[{"type":"integer","description":"Where the contact came from.","uniqueKey":"customer.oneOf.0.sourceId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Where the contact came from.","uniqueKey":"customer.oneOf.0.sourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.sourceId","typeLabel":"integer | null"},"assignedToId":{"oneOf":[{"type":"integer","description":"The staff member (organization user id) following the contact up.","uniqueKey":"customer.oneOf.0.assignedToId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The staff member (organization user id) following the contact up.","uniqueKey":"customer.oneOf.0.assignedToId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.oneOf.0.assignedToId","typeLabel":"integer | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"customer.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"customer.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"customer.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer","typeLabel":"object | null"},"money":{"type":"object","description":"What the booking costs and how it was paid. Present only with `include=money`, which additionally requires the `transactions:read` scope. `billed` is always `paid + outstanding`, on the same basis as the admin's Booking audit: tax-inclusive, net of refunds, so a cancelled booking bills only the Cancellation Charge it kept.","properties":{"billed":{"type":"number","uniqueKey":"money.billed","typeLabel":"number"},"billedExTax":{"type":"number","uniqueKey":"money.billedExTax","typeLabel":"number"},"paid":{"type":"number","description":"Money the club kept: collected, net of refunds.","uniqueKey":"money.paid","typeLabel":"number"},"outstanding":{"type":"number","description":"Still owed on the booking. A closed charge owes nothing.","uniqueKey":"money.outstanding","typeLabel":"number"},"paymentState":{"type":"string","description":"paid, partial, unpaid, refunded, covered or free.","uniqueKey":"money.paymentState","typeLabel":"string"},"paymentStatus":{"oneOf":[{"type":"string","description":"The charges' own payment statuses, `/`-joined.","uniqueKey":"money.paymentStatus.oneOf.0","typeLabel":"string"},{"type":"null","description":"The charges' own payment statuses, `/`-joined.","uniqueKey":"money.paymentStatus.oneOf.1","typeLabel":"null"}],"uniqueKey":"money.paymentStatus","typeLabel":"string | null"},"charges":{"type":"array","items":{"type":"object","properties":{"transactionId":{"type":"integer","uniqueKey":"money.charges.items.[INDEX].transactionId","typeLabel":"integer"},"transactionType":{"oneOf":[{"type":"string","uniqueKey":"money.charges.items.[INDEX].transactionType.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"money.charges.items.[INDEX].transactionType.oneOf.1","typeLabel":"null"}],"uniqueKey":"money.charges.items.[INDEX].transactionType","typeLabel":"string | null"},"payerContactId":{"oneOf":[{"type":"integer","description":"Who the charge is on: the organizer, or a player paying their own share.","uniqueKey":"money.charges.items.[INDEX].payerContactId.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Who the charge is on: the organizer, or a player paying their own share.","uniqueKey":"money.charges.items.[INDEX].payerContactId.oneOf.1","typeLabel":"null"}],"uniqueKey":"money.charges.items.[INDEX].payerContactId","typeLabel":"integer | null"},"date":{"type":"string","format":"date-time","uniqueKey":"money.charges.items.[INDEX].date","typeLabel":"string\u003cdate-time>"},"paymentStatus":{"type":"string","uniqueKey":"money.charges.items.[INDEX].paymentStatus","typeLabel":"string"},"amount":{"type":"number","description":"What the charge bills, after any cancellation credit against it.","uniqueKey":"money.charges.items.[INDEX].amount","typeLabel":"number"},"paidAmount":{"type":"number","uniqueKey":"money.charges.items.[INDEX].paidAmount","typeLabel":"number"},"refundedAmount":{"type":"number","description":"Returned from its payments by a refund.","uniqueKey":"money.charges.items.[INDEX].refundedAmount","typeLabel":"number"},"outstandingAmount":{"type":"number","uniqueKey":"money.charges.items.[INDEX].outstandingAmount","typeLabel":"number"},"invoiceIds":{"type":"array","items":{"type":"integer","uniqueKey":"money.charges.items.[INDEX].invoiceIds.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"money.charges.items.[INDEX].invoiceIds","typeLabel":"integer[]"},"orderId":{"oneOf":[{"type":"integer","uniqueKey":"money.charges.items.[INDEX].orderId.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"money.charges.items.[INDEX].orderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"money.charges.items.[INDEX].orderId","typeLabel":"integer | null"}},"uniqueKey":"money.charges.items.[INDEX]","typeLabel":"object"},"uniqueKey":"money.charges","typeLabel":"object[]"},"credits":{"type":"array","description":"Cancellation credits: what a cancellation took off a charge.","items":{"type":"object","properties":{"transactionId":{"type":"integer","uniqueKey":"money.credits.items.[INDEX].transactionId","typeLabel":"integer"},"chargeTransactionId":{"oneOf":[{"type":"integer","uniqueKey":"money.credits.items.[INDEX].chargeTransactionId.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"money.credits.items.[INDEX].chargeTransactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"money.credits.items.[INDEX].chargeTransactionId","typeLabel":"integer | null"},"amount":{"type":"number","uniqueKey":"money.credits.items.[INDEX].amount","typeLabel":"number"},"paymentStatus":{"type":"string","uniqueKey":"money.credits.items.[INDEX].paymentStatus","typeLabel":"string"},"date":{"type":"string","format":"date-time","uniqueKey":"money.credits.items.[INDEX].date","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"money.credits.items.[INDEX]","typeLabel":"object"},"uniqueKey":"money.credits","typeLabel":"object[]"},"payments":{"type":"array","items":{"type":"object","properties":{"paymentId":{"type":"integer","uniqueKey":"money.payments.items.[INDEX].paymentId","typeLabel":"integer"},"amount":{"type":"number","uniqueKey":"money.payments.items.[INDEX].amount","typeLabel":"number"},"status":{"type":"string","uniqueKey":"money.payments.items.[INDEX].status","typeLabel":"string"},"method":{"type":"string","uniqueKey":"money.payments.items.[INDEX].method","typeLabel":"string"},"source":{"oneOf":[{"type":"string","uniqueKey":"money.payments.items.[INDEX].source.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"money.payments.items.[INDEX].source.oneOf.1","typeLabel":"null"}],"uniqueKey":"money.payments.items.[INDEX].source","typeLabel":"string | null"},"reference":{"oneOf":[{"type":"string","uniqueKey":"money.payments.items.[INDEX].reference.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"money.payments.items.[INDEX].reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"money.payments.items.[INDEX].reference","typeLabel":"string | null"},"paidAt":{"type":"string","format":"date-time","uniqueKey":"money.payments.items.[INDEX].paidAt","typeLabel":"string\u003cdate-time>"},"transactionIds":{"type":"array","items":{"type":"integer","uniqueKey":"money.payments.items.[INDEX].transactionIds.items.[INDEX]","typeLabel":"integer"},"uniqueKey":"money.payments.items.[INDEX].transactionIds","typeLabel":"integer[]"}},"uniqueKey":"money.payments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"money.payments","typeLabel":"object[]"},"refunds":{"type":"array","items":{"type":"object","properties":{"refundId":{"type":"integer","uniqueKey":"money.refunds.items.[INDEX].refundId","typeLabel":"integer"},"transactionId":{"oneOf":[{"type":"integer","uniqueKey":"money.refunds.items.[INDEX].transactionId.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"money.refunds.items.[INDEX].transactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"money.refunds.items.[INDEX].transactionId","typeLabel":"integer | null"},"paymentId":{"type":"integer","uniqueKey":"money.refunds.items.[INDEX].paymentId","typeLabel":"integer"},"amount":{"type":"number","uniqueKey":"money.refunds.items.[INDEX].amount","typeLabel":"number"},"destination":{"type":"string","enum":["stripe","wallet","cash","manual"],"uniqueKey":"money.refunds.items.[INDEX].destination","typeLabel":"enum\u003cstring>"},"reason":{"oneOf":[{"type":"string","uniqueKey":"money.refunds.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"money.refunds.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"money.refunds.items.[INDEX].reason","typeLabel":"string | null"},"refundedAt":{"type":"string","format":"date-time","uniqueKey":"money.refunds.items.[INDEX].refundedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"money.refunds.items.[INDEX]","typeLabel":"object"},"uniqueKey":"money.refunds","typeLabel":"object[]"}},"uniqueKey":"money","typeLabel":"object"},"cancellation":{"type":"object","description":"The cancellation terms stamped on the booking and how it was cancelled. Present only with `include=cancellation`.","properties":{"terms":{"oneOf":[{"type":"object","description":"The terms the customer accepted with the booking - not the club's policy today, which may since have changed. `null` for an event ticket, whose event keeps its own terms, and for a booking accepted before terms were stamped.","properties":{"acceptedAt":{"type":"string","format":"date-time","uniqueKey":"cancellation.terms.oneOf.0.acceptedAt","typeLabel":"string\u003cdate-time>"},"rules":{"type":"array","items":{"type":"object","properties":{"hoursInAdvance":{"type":"number","uniqueKey":"cancellation.terms.oneOf.0.rules.items.[INDEX].hoursInAdvance","typeLabel":"number"},"refundPercentage":{"type":"number","uniqueKey":"cancellation.terms.oneOf.0.rules.items.[INDEX].refundPercentage","typeLabel":"number"},"description":{"type":"string","uniqueKey":"cancellation.terms.oneOf.0.rules.items.[INDEX].description","typeLabel":"string"}},"uniqueKey":"cancellation.terms.oneOf.0.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"cancellation.terms.oneOf.0.rules","typeLabel":"object[]"},"deadlines":{"type":"array","description":"Every band that refunds something, as the moment to cancel by, widest notice first.","items":{"type":"object","properties":{"until":{"type":"string","format":"date-time","uniqueKey":"cancellation.terms.oneOf.0.deadlines.items.[INDEX].until","typeLabel":"string\u003cdate-time>"},"refundPercentage":{"type":"number","uniqueKey":"cancellation.terms.oneOf.0.deadlines.items.[INDEX].refundPercentage","typeLabel":"number"}},"uniqueKey":"cancellation.terms.oneOf.0.deadlines.items.[INDEX]","typeLabel":"object"},"uniqueKey":"cancellation.terms.oneOf.0.deadlines","typeLabel":"object[]"},"freeCancellationUntil":{"oneOf":[{"type":"string","format":"date-time","description":"The last moment a cancellation refunds in full; `null` when no band does.","uniqueKey":"cancellation.terms.oneOf.0.freeCancellationUntil.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The last moment a cancellation refunds in full; `null` when no band does.","uniqueKey":"cancellation.terms.oneOf.0.freeCancellationUntil.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.terms.oneOf.0.freeCancellationUntil","typeLabel":"string\u003cdate-time> | null"},"cancellationCutoffAt":{"oneOf":[{"type":"string","format":"date-time","description":"From this moment the customer can no longer cancel the booking themselves; only staff can. `null` when the terms set no cutoff.","uniqueKey":"cancellation.terms.oneOf.0.cancellationCutoffAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"From this moment the customer can no longer cancel the booking themselves; only staff can. `null` when the terms set no cutoff.","uniqueKey":"cancellation.terms.oneOf.0.cancellationCutoffAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.terms.oneOf.0.cancellationCutoffAt","typeLabel":"string\u003cdate-time> | null"},"fullyCovered":{"type":"boolean","description":"A membership or pass covered the whole booking.","uniqueKey":"cancellation.terms.oneOf.0.fullyCovered","typeLabel":"boolean"},"collectsFromWallet":{"type":"boolean","description":"The Cancellation Charge is taken from the Wallet.","uniqueKey":"cancellation.terms.oneOf.0.collectsFromWallet","typeLabel":"boolean"},"waiver":{"oneOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","uniqueKey":"cancellation.terms.oneOf.0.waiver.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"byUserId":{"oneOf":[{"type":"integer","uniqueKey":"cancellation.terms.oneOf.0.waiver.oneOf.0.byUserId.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"cancellation.terms.oneOf.0.waiver.oneOf.0.byUserId.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.terms.oneOf.0.waiver.oneOf.0.byUserId","typeLabel":"integer | null"},"reason":{"type":"string","uniqueKey":"cancellation.terms.oneOf.0.waiver.oneOf.0.reason","typeLabel":"string"}},"uniqueKey":"cancellation.terms.oneOf.0.waiver.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"at":{"type":"string","format":"date-time"},"byUserId":{"oneOf":[{"type":"integer"},{"type":"null"}]},"reason":{"type":"string"}},"uniqueKey":"cancellation.terms.oneOf.0.waiver.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.terms.oneOf.0.waiver","typeLabel":"object | null"}},"uniqueKey":"cancellation.terms.oneOf.0","typeLabel":"object"},{"type":"null","description":"The terms the customer accepted with the booking - not the club's policy today, which may since have changed. `null` for an event ticket, whose event keeps its own terms, and for a booking accepted before terms were stamped.","properties":{"acceptedAt":{"type":"string","format":"date-time"},"rules":{"type":"array","items":{"type":"object","properties":{"hoursInAdvance":{"type":"number"},"refundPercentage":{"type":"number"},"description":{"type":"string"}}}},"deadlines":{"type":"array","description":"Every band that refunds something, as the moment to cancel by, widest notice first.","items":{"type":"object","properties":{"until":{"type":"string","format":"date-time"},"refundPercentage":{"type":"number"}}}},"freeCancellationUntil":{"oneOf":[{"type":"string","format":"date-time","description":"The last moment a cancellation refunds in full; `null` when no band does."},{"type":"null","format":"date-time","description":"The last moment a cancellation refunds in full; `null` when no band does."}]},"cancellationCutoffAt":{"oneOf":[{"type":"string","format":"date-time","description":"From this moment the customer can no longer cancel the booking themselves; only staff can. `null` when the terms set no cutoff."},{"type":"null","format":"date-time","description":"From this moment the customer can no longer cancel the booking themselves; only staff can. `null` when the terms set no cutoff."}]},"fullyCovered":{"type":"boolean","description":"A membership or pass covered the whole booking."},"collectsFromWallet":{"type":"boolean","description":"The Cancellation Charge is taken from the Wallet."},"waiver":{"oneOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time"},"byUserId":{"oneOf":[{"type":"integer"},{"type":"null"}]},"reason":{"type":"string"}}},{"type":"null","properties":{"at":{"type":"string","format":"date-time"},"byUserId":{"oneOf":[{"type":"integer"},{"type":"null"}]},"reason":{"type":"string"}}}]}},"uniqueKey":"cancellation.terms.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.terms","typeLabel":"object | null"},"cancelled":{"oneOf":[{"type":"object","description":"`null` while the booking is not cancelled.","properties":{"at":{"type":"string","format":"date-time","uniqueKey":"cancellation.cancelled.oneOf.0.at","typeLabel":"string\u003cdate-time>"},"by":{"oneOf":[{"type":"object","properties":{"userId":{"type":"integer","uniqueKey":"cancellation.cancelled.oneOf.0.by.oneOf.0.userId","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"cancellation.cancelled.oneOf.0.by.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"cancellation.cancelled.oneOf.0.by.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"userId":{"type":"integer"},"name":{"type":"string"}},"uniqueKey":"cancellation.cancelled.oneOf.0.by.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.cancelled.oneOf.0.by","typeLabel":"object | null"},"reason":{"oneOf":[{"type":"string","uniqueKey":"cancellation.cancelled.oneOf.0.reason.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"cancellation.cancelled.oneOf.0.reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.cancelled.oneOf.0.reason","typeLabel":"string | null"},"noticeHours":{"type":"number","description":"Hours between the cancellation and the start; negative when it came after the start.","uniqueKey":"cancellation.cancelled.oneOf.0.noticeHours","typeLabel":"number"},"refundPercentage":{"oneOf":[{"type":"number","uniqueKey":"cancellation.cancelled.oneOf.0.refundPercentage.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"cancellation.cancelled.oneOf.0.refundPercentage.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.cancelled.oneOf.0.refundPercentage","typeLabel":"number | null"},"refundAmount":{"oneOf":[{"type":"number","uniqueKey":"cancellation.cancelled.oneOf.0.refundAmount.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"cancellation.cancelled.oneOf.0.refundAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.cancelled.oneOf.0.refundAmount","typeLabel":"number | null"},"policyWaived":{"type":"boolean","uniqueKey":"cancellation.cancelled.oneOf.0.policyWaived","typeLabel":"boolean"},"notes":{"oneOf":[{"type":"string","uniqueKey":"cancellation.cancelled.oneOf.0.notes.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"cancellation.cancelled.oneOf.0.notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.cancelled.oneOf.0.notes","typeLabel":"string | null"}},"uniqueKey":"cancellation.cancelled.oneOf.0","typeLabel":"object"},{"type":"null","description":"`null` while the booking is not cancelled.","properties":{"at":{"type":"string","format":"date-time"},"by":{"oneOf":[{"type":"object","properties":{"userId":{"type":"integer"},"name":{"type":"string"}}},{"type":"null","properties":{"userId":{"type":"integer"},"name":{"type":"string"}}}]},"reason":{"oneOf":[{"type":"string"},{"type":"null"}]},"noticeHours":{"type":"number","description":"Hours between the cancellation and the start; negative when it came after the start."},"refundPercentage":{"oneOf":[{"type":"number"},{"type":"null"}]},"refundAmount":{"oneOf":[{"type":"number"},{"type":"null"}]},"policyWaived":{"type":"boolean"},"notes":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"cancellation.cancelled.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.cancelled","typeLabel":"object | null"}},"uniqueKey":"cancellation","typeLabel":"object"},"payment":{"type":"object","properties":{"status":{"type":"string","enum":["paid","unpaid","no_charge"],"description":"`no_charge` means there is nothing to collect: either nothing was ever owed (a free area, an amount of 0) or an entitlement covers it - a membership or external program the attendee already holds, which is why a covered booking can carry a price and still owe nothing. `paid` counts every financially closed transaction status (`paid`, `settled`, `refunded`), and every charge type, not only the one this API records.","uniqueKey":"payment.status","typeLabel":"enum\u003cstring>"},"amount":{"oneOf":[{"type":"number","description":"The booking's recorded price in the organization's currency; `status` is what says whether anything was collectable. Where the price is 0 but a real charge exists - an external program's per-visit fee lives entirely in its transaction - the ledger total is reported instead.","uniqueKey":"payment.amount.oneOf.0","typeLabel":"number"},{"type":"null","description":"The booking's recorded price in the organization's currency; `status` is what says whether anything was collectable. Where the price is 0 but a real charge exists - an external program's per-visit fee lives entirely in its transaction - the ledger total is reported instead.","uniqueKey":"payment.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.amount","typeLabel":"number | null"},"paidAmount":{"type":"number","description":"What has been collected on the booking, gross, before any refund. `0` when nothing has.","uniqueKey":"payment.paidAmount","typeLabel":"number"},"refundedAmount":{"type":"number","description":"What has been returned to the customer, across every refund recorded. `paidAmount - refundedAmount` is what the club kept.","uniqueKey":"payment.refundedAmount","typeLabel":"number"},"reference":{"oneOf":[{"type":"string","description":"The collecting partner's own id for the payment, when one reported it through this API (`payment.reference`); null for money 1club collected itself.","uniqueKey":"payment.reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The collecting partner's own id for the payment, when one reported it through this API (`payment.reference`); null for money 1club collected itself.","uniqueKey":"payment.reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.reference","typeLabel":"string | null"},"fee":{"oneOf":[{"type":"number","description":"What the collecting partner kept out of the amount, when it reported one (`payment.fee`).","uniqueKey":"payment.fee.oneOf.0","typeLabel":"number"},{"type":"null","description":"What the collecting partner kept out of the amount, when it reported one (`payment.fee`).","uniqueKey":"payment.fee.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.fee","typeLabel":"number | null"}},"uniqueKey":"payment","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"bookingId":123,"bookingUuid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"\u003cstring>","areaId":123,"classId":123,"eventId":123,"eventTicketId":123,"orderId":123,"seatBookingIds":[123],"maxPlayers":123,"instructorId":123,"contactId":123,"startTime":"2023-11-07T05:31:56Z","endTime":"2023-11-07T05:31:56Z","customer":{"id":123,"uuid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","email":"\u003cstring>","phone":"\u003cstring>","type":"\u003cstring>","pipelineStageId":123,"pipelineLostReason":"price","pipelineLostNote":"\u003cstring>","sourceId":123,"assignedToId":123,"createdAt":"2023-11-07T05:31:56Z"},"money":{"billed":123,"billedExTax":123,"paid":123,"outstanding":123,"paymentState":"\u003cstring>","paymentStatus":"\u003cstring>","charges":[{"transactionId":123,"transactionType":"\u003cstring>","payerContactId":123,"date":"2023-11-07T05:31:56Z","paymentStatus":"\u003cstring>","amount":123,"paidAmount":123,"refundedAmount":123,"outstandingAmount":123,"invoiceIds":[123],"orderId":123}],"credits":[{"transactionId":123,"chargeTransactionId":123,"amount":123,"paymentStatus":"\u003cstring>","date":"2023-11-07T05:31:56Z"}],"payments":[{"paymentId":123,"amount":123,"status":"\u003cstring>","method":"\u003cstring>","source":"\u003cstring>","reference":"\u003cstring>","paidAt":"2023-11-07T05:31:56Z","transactionIds":[123]}],"refunds":[{"refundId":123,"transactionId":123,"paymentId":123,"amount":123,"destination":"stripe","reason":"\u003cstring>","refundedAt":"2023-11-07T05:31:56Z"}]},"cancellation":{"terms":{"acceptedAt":"2023-11-07T05:31:56Z","rules":[{"hoursInAdvance":123,"refundPercentage":123,"description":"\u003cstring>"}],"deadlines":[{"until":"2023-11-07T05:31:56Z","refundPercentage":123}],"freeCancellationUntil":"2023-11-07T05:31:56Z","cancellationCutoffAt":"2023-11-07T05:31:56Z","fullyCovered":true,"collectsFromWallet":true,"waiver":{"at":"2023-11-07T05:31:56Z","byUserId":123,"reason":"\u003cstring>"}},"cancelled":{"at":"2023-11-07T05:31:56Z","by":{"userId":123,"name":"\u003cstring>"},"reason":"\u003cstring>","noticeHours":123,"refundPercentage":123,"refundAmount":123,"policyWaived":true,"notes":"\u003cstring>"}},"payment":{"status":"paid","amount":123,"paidAmount":123,"refundedAmount":123,"reference":"\u003cstring>","fee":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"ce86b189-b55b-4ad1-87f9-c2d36bc52641":{"description":"Invalid request, or an edit that cannot hold: `BOOKING_CANCELLED`, `BOOKING_ON_CLASS_NOT_RESCHEDULABLE`, `BOOKING_NEEDS_RESOURCE`, `BOOKING_COVERED_CANNOT_PRICE`, `CLASS_AT_CAPACITY`, `AREA_NOT_FOUND`, `CONTACT_NOT_FOUND`, `RECURRENCE_REQUIRES_SERIES_SCOPE` (a `recurrence` sent to an occurrence without `scope=all_future`), `RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY`, `DISCOUNTED_BOOKING_TO_SERIES` (a `recurrence` sent to a booking that carries a discount - take the discount off first), `SERIES_EXTERNAL_PROGRAM_UNSUPPORTED` (a `recurrence` sent to a booking on an external program, which pays visits one booking at a time), `PROMOTION_NOT_REDEEMABLE` in `error` (a `contactId` the booking's discount cannot pass to, with the reason in `code`), or a taken slot, which carries `details.conflicts[]` as on create.\n","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"},"bba66a98-d1c6-4d87-95a7-10675006789c":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"9f016f73-3b94-4cd7-986a-d3d10c662444":{"description":"API key is missing the required `bookings:write` scope","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"},"94e5f210-0a10-4e7b-9b05-495bf3d15775":{"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"},"ab5b4072-aa81-4f9f-853e-eeca1629c68a":{"description":"The booking is managed by another API key that owns its own records (`BOOKING_EXTERNALLY_MANAGED`, with the managing integration's name in `details.managedBy`); or the new price is below what has already been paid on the booking (`BOOKING_CHARGE_OVERPAID`), which needs a refund rather than an edit; or a part-paid or invoiced charge cannot be rewritten (`BOOKING_CHARGE_NEEDS_ADJUSTMENT`); or an `Idempotency-Key` was reused with a different request body.\n","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"},"d91705a1-769a-4246-ab54-be300697632e":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`).","uniqueKey":"code","typeLabel":"string"},"details":{"type":"object","additionalProperties":true,"description":"Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`.","uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"85132dc8-04d6-4a8b-94f9-3a94819bd586":{"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 booking - 1club Help","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-20T14:43:52.811Z","originalFileLocation":"api-reference/bookings/update-a-booking.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=\"Edits a booking by its 1club id: reschedule it, move it to another area, attach or remove an instructor, reassign the contact, change its notes or price, or make it recur. Send only the fields that change. Reaches the same bookings as cancel: an API key only those it created, a staff member through an authorized 1club assistant any of the organization\u0026#x27;s. The edit follows the admin portal\u0026#x27;s rules. A cancelled booking is final, and a booking on a class takes its time and price from the class. As on create, the club\u0026#x27;s member-facing policy (operating hours, instructor availability) is not applied, but an occupied or blocked court, or a coach who is already booked, is refused with details.conflicts[]. Money follows the edit. amount reprices the booking to your figure. Without it, a booking this API created keeps its price, and a booking taken through 1club is re-quoted when the slot, area, instructor or contact changes. The charge is then reconciled: an increase on a paid booking leaves the difference outstanding, and a decrease below what was paid needs a refund, which this endpoint does not perform. Payment status cannot be changed here. Recurring bookings. recurrence on a one-off booking makes it the first occurrence of a series. On an occurrence of a series, scope=all_future applies the edit to this occurrence and every later one that has not started yet (earlier dates keep what they have): a new startTime/endTime gives each that time of day on its own date (the weekday changes only through recurrence.daysOfWeek), a new area or instructor is checked against every date, and a new recurrence rewrites the cadence or end condition; days dropped from a weekly pattern are cancelled with their refund. A series bound to a recurring class follows the class and cannot be re-timed, and a booking an API key created cannot be made to recur at all (RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY): 1club would be generating occurrences that key never created, so each one is its own booking. An edit whose series has already run touches nothing.\">\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 booking - 1club Help\">\u003cmeta data-mint-head property=\"og:description\" content=\"Edits a booking by its 1club id: reschedule it, move it to another area, attach or remove an instructor, reassign the contact, change its notes or price, or make it recur. Send only the fields that change. Reaches the same bookings as cancel: an API key only those it created, a staff member through an authorized 1club assistant any of the organization\u0026#x27;s. The edit follows the admin portal\u0026#x27;s rules. A cancelled booking is final, and a booking on a class takes its time and price from the class. As on create, the club\u0026#x27;s member-facing policy (operating hours, instructor availability) is not applied, but an occupied or blocked court, or a coach who is already booked, is refused with details.conflicts[]. Money follows the edit. amount reprices the booking to your figure. Without it, a booking this API created keeps its price, and a booking taken through 1club is re-quoted when the slot, area, instructor or contact changes. The charge is then reconciled: an increase on a paid booking leaves the difference outstanding, and a decrease below what was paid needs a refund, which this endpoint does not perform. Payment status cannot be changed here. Recurring bookings. recurrence on a one-off booking makes it the first occurrence of a series. On an occurrence of a series, scope=all_future applies the edit to this occurrence and every later one that has not started yet (earlier dates keep what they have): a new startTime/endTime gives each that time of day on its own date (the weekday changes only through recurrence.daysOfWeek), a new area or instructor is checked against every date, and a new recurrence rewrites the cadence or end condition; days dropped from a weekly pattern are cancelled with their refund. A series bound to a recurring class follows the class and cannot be re-timed, and a booking an API key created cannot be made to recur at all (RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY): 1club would be generating occurrences that key never created, so each one is its own booking. An edit whose series has already run touches nothing.\">\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/bookings/update-a-booking\">\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=Bookings\u0026amp;title=Update+a+booking\u0026amp;description=Edits+a+booking+by+its+1club+id%3A+reschedule+it%2C+move+it+to+another+area%2C+attach+or+remove+an+instructor%2C+reassign+the+contact%2C+change+its+notes+or+price%2C+or+mak\u0026amp;theme=ed3cd824c84f0d7b56c4d20a\u0026amp;signature=bef10b89397690970f5945500f548ff0bdc6409e5876521837b97976c70b41f5\">\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 booking - 1club Help\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Edits a booking by its 1club id: reschedule it, move it to another area, attach or remove an instructor, reassign the contact, change its notes or price, or make it recur. Send only the fields that change. Reaches the same bookings as cancel: an API key only those it created, a staff member through an authorized 1club assistant any of the organization\u0026#x27;s. The edit follows the admin portal\u0026#x27;s rules. A cancelled booking is final, and a booking on a class takes its time and price from the class. As on create, the club\u0026#x27;s member-facing policy (operating hours, instructor availability) is not applied, but an occupied or blocked court, or a coach who is already booked, is refused with details.conflicts[]. Money follows the edit. amount reprices the booking to your figure. Without it, a booking this API created keeps its price, and a booking taken through 1club is re-quoted when the slot, area, instructor or contact changes. The charge is then reconciled: an increase on a paid booking leaves the difference outstanding, and a decrease below what was paid needs a refund, which this endpoint does not perform. Payment status cannot be changed here. Recurring bookings. recurrence on a one-off booking makes it the first occurrence of a series. On an occurrence of a series, scope=all_future applies the edit to this occurrence and every later one that has not started yet (earlier dates keep what they have): a new startTime/endTime gives each that time of day on its own date (the weekday changes only through recurrence.daysOfWeek), a new area or instructor is checked against every date, and a new recurrence rewrites the cadence or end condition; days dropped from a weekly pattern are cancelled with their refund. A series bound to a recurring class follows the class and cannot be re-timed, and a booking an API key created cannot be made to recur at all (RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY): 1club would be generating occurrences that key never created, so each one is its own booking. An edit whose series has already run touches nothing.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://1club.mintlify.site/_mintlify/api/og/v2?division=Bookings\u0026amp;title=Update+a+booking\u0026amp;description=Edits+a+booking+by+its+1club+id%3A+reschedule+it%2C+move+it+to+another+area%2C+attach+or+remove+an+instructor%2C+reassign+the+contact%2C+change+its+notes+or+price%2C+or+mak\u0026amp;theme=ed3cd824c84f0d7b56c4d20a\u0026amp;signature=bef10b89397690970f5945500f548ff0bdc6409e5876521837b97976c70b41f5\">\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/bookings/update-a-booking\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/bookings/update-a-booking.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/bookings/update-a-booking#webpage\",\"url\":\"https://docs.1club.ai/api-reference/bookings/update-a-booking\",\"name\":\"Update a booking\",\"description\":\"Edits a booking by its 1club id: reschedule it, move it to another area, attach or remove an instructor, reassign the contact, change its notes or price, or make it recur. Send only the fields that change. Reaches the same bookings as cancel: an API key only those it created, a staff member through an authorized 1club assistant any of the organization's. The edit follows the admin portal's rules. A cancelled booking is final, and a booking on a class takes its time and price from the class. As on create, the club's member-facing policy (operating hours, instructor availability) is not applied, but an occupied or blocked court, or a coach who is already booked, is refused with details.conflicts[]. Money follows the edit. amount reprices the booking to your figure. Without it, a booking this API created keeps its price, and a booking taken through 1club is re-quoted when the slot, area, instructor or contact changes. The charge is then reconciled: an increase on a paid booking leaves the difference outstanding, and a decrease below what was paid needs a refund, which this endpoint does not perform. Payment status cannot be changed here. Recurring bookings. recurrence on a one-off booking makes it the first occurrence of a series. On an occurrence of a series, scope=all_future applies the edit to this occurrence and every later one that has not started yet (earlier dates keep what they have): a new startTime/endTime gives each that time of day on its own date (the weekday changes only through recurrence.daysOfWeek), a new area or instructor is checked against every date, and a new recurrence rewrites the cadence or end condition; days dropped from a weekly pattern are cancelled with their refund. A series bound to a recurring class follows the class and cannot be re-timed, and a booking an API key created cannot be made to recur at all (RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY): 1club would be generating occurrences that key never created, so each one is its own booking. An edit whose series has already run touches nothing.\",\"dateModified\":\"2026-11-20T14:43:52.811Z\",\"isPartOf\":{\"@id\":\"https://docs.1club.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.1club.ai/api-reference/bookings/update-a-booking#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.1club.ai/api-reference/bookings/update-a-booking#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Bookings\",\"item\":\"https://docs.1club.ai/api-reference/bookings/list-bookings\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a booking\",\"item\":\"https://docs.1club.ai/api-reference/bookings/update-a-booking\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.1club.ai/api-reference/bookings/update-a-booking#apireference\",\"headline\":\"Update a booking\",\"name\":\"Update a booking\",\"description\":\"Edits a booking by its 1club id: reschedule it, move it to another area, attach or remove an instructor, reassign the contact, change its notes or price, or make it recur. Send only the fields that change. Reaches the same bookings as cancel: an API key only those it created, a staff member through an authorized 1club assistant any of the organization's. The edit follows the admin portal's rules. A cancelled booking is final, and a booking on a class takes its time and price from the class. As on create, the club's member-facing policy (operating hours, instructor availability) is not applied, but an occupied or blocked court, or a coach who is already booked, is refused with details.conflicts[]. Money follows the edit. amount reprices the booking to your figure. Without it, a booking this API created keeps its price, and a booking taken through 1club is re-quoted when the slot, area, instructor or contact changes. The charge is then reconciled: an increase on a paid booking leaves the difference outstanding, and a decrease below what was paid needs a refund, which this endpoint does not perform. Payment status cannot be changed here. Recurring bookings. recurrence on a one-off booking makes it the first occurrence of a series. On an occurrence of a series, scope=all_future applies the edit to this occurrence and every later one that has not started yet (earlier dates keep what they have): a new startTime/endTime gives each that time of day on its own date (the weekday changes only through recurrence.daysOfWeek), a new area or instructor is checked against every date, and a new recurrence rewrites the cadence or end condition; days dropped from a weekly pattern are cancelled with their refund. A series bound to a recurring class follows the class and cannot be re-timed, and a booking an API key created cannot be made to recur at all (RECURRENCE_NOT_AVAILABLE_TO_MANAGING_KEY): 1club would be generating occurrences that key never created, so each one is its own booking. An edit whose series has already run touches nothing.\",\"url\":\"https://docs.1club.ai/api-reference/bookings/update-a-booking\",\"mainEntityOfPage\":{\"@id\":\"https://docs.1club.ai/api-reference/bookings/update-a-booking#webpage\"},\"dateModified\":\"2026-11-20T14:43:52.811Z\",\"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/bookings/update-a-booking.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","description":"Permanently removes a booking entered by mistake or as a test, as if it had never been made - unlike cancelling, which keeps it on the books. Its charges and cancellation records are deleted with it, and so are its players, check-ins, the instructor's pay for it and the door access it granted. It cannot be undone.\n\nRefused with `409 BOOKING_HAS_PAYMENTS` while any of its charges was paid or has a payment, invoice, Wallet movement or refund behind it: cancel it and refund instead, so the sale stays in the books. Refused with `409 BOOKING_ON_OPEN_ORDER` (or `409 CHARGE_ON_OPEN_ORDER`) while an open order still holds it or one of its charges, and one seat of a registration with guests with `409 BOOKING_HAS_SEATS` until the registration is cancelled. Charges recorded on its check-ins count as its own. A visit it drew from a pass, the organizer's or a player's, goes back on the pass unless it was cancelled, and its External Program usages are deleted with it. An API key may delete only bookings made through the API, and never one another key manages (`409 BOOKING_EXTERNALLY_MANAGED`). For a member of staff, it needs the Extended level of booking delete, which only admins hold by default.\n","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","description":"Lets the member off what a cancelled or missed (`no_show`) booking still owes under its cancellation terms, as the club's staff do from the booking: the unpaid charge is withdrawn, anything already taken from the member's Wallet for it is given back, and the reason is recorded on the booking. Money the member paid upfront stays paid. Waiving a booking already waived changes nothing. A booking that is not cancelled or missed, or carries no cancellation terms, is a 404. An API key reaches only the bookings it made through the API, and never another key's managed booking.\n","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/bookings/{id}/cancellation-charge/waive","href":"/api-reference/bookings/waive-a-bookings-cancellation-charge"},{"title":"List the additional players on a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/bookings/{id}/participants","href":"/api-reference/bookings/list-the-additional-players-on-a-booking"},{"title":"Add a player to a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/bookings/{id}/participants","href":"/api-reference/bookings/add-a-player-to-a-booking"},{"title":"Remove a player from a booking","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/bookings/{id}/participants/{contactId}","href":"/api-reference/bookings/remove-a-player-from-a-booking"}]},{"group":"Check-ins","pages":[{"title":"List check-ins","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/checkins","href":"/api-reference/check-ins/list-check-ins"},{"title":"Check in a booking or a member","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/checkins","href":"/api-reference/check-ins/check-in-a-booking-or-a-member"},{"title":"Get a check-in","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/checkins/{id}","href":"/api-reference/check-ins/get-a-check-in"}]},{"group":"Classes","pages":[{"title":"List class types","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/class-types","href":"/api-reference/classes/list-class-types"},{"title":"Create a class type","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/class-types","href":"/api-reference/classes/create-a-class-type"},{"title":"Get a class type","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/class-types/{id}","href":"/api-reference/classes/get-a-class-type"},{"title":"Update a class type","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/class-types/{id}","href":"/api-reference/classes/update-a-class-type"},{"title":"Reorder class types","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/class-types/order","href":"/api-reference/classes/reorder-class-types"},{"title":"List classes","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/classes","href":"/api-reference/classes/list-classes"},{"title":"Create a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/classes","href":"/api-reference/classes/create-a-class"},{"title":"List a class's roster","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/classes/{id}/bookings","href":"/api-reference/classes/list-a-classs-roster"},{"title":"Book a customer into a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/classes/{id}/bookings","href":"/api-reference/classes/book-a-customer-into-a-class"},{"title":"Get a class by ID","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/classes/{id}","href":"/api-reference/classes/get-a-class-by-id"},{"title":"Delete a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/classes/{id}","href":"/api-reference/classes/delete-a-class"},{"title":"Update a class","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/classes/{id}","href":"/api-reference/classes/update-a-class"},{"title":"List programs","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/programs","href":"/api-reference/classes/list-programs"},{"title":"Create a program","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/programs","href":"/api-reference/classes/create-a-program"},{"title":"Get a program","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/programs/{id}","href":"/api-reference/classes/get-a-program"},{"title":"Update a program","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/programs/{id}","href":"/api-reference/classes/update-a-program"},{"title":"List progression tracks","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/progression-tracks","href":"/api-reference/classes/list-progression-tracks"},{"title":"Create a progression track","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/progression-tracks","href":"/api-reference/classes/create-a-progression-track"},{"title":"Get a progression track","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/progression-tracks/{id}","href":"/api-reference/classes/get-a-progression-track"},{"title":"Update a progression track","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/progression-tracks/{id}","href":"/api-reference/classes/update-a-progression-track"}]},{"group":"Clubs","pages":[{"title":"List clubs","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/clubs","href":"/api-reference/clubs/list-clubs"},{"title":"Get club details by slug","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/clubs/{slug}","href":"/api-reference/clubs/get-club-details-by-slug"},{"title":"Update a club's booking-card labels","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/clubs/{slug}","href":"/api-reference/clubs/update-a-clubs-booking-card-labels"},{"title":"Update a club's profile","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/clubs/{slug}/profile","href":"/api-reference/clubs/update-a-clubs-profile"}]},{"group":"Competitors","pages":[{"title":"List competitors","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors","href":"/api-reference/competitors/list-competitors"},{"title":"Add a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/competitors","href":"/api-reference/competitors/add-a-competitor"},{"title":"Compare prices with the market","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors/market","href":"/api-reference/competitors/compare-prices-with-the-market"},{"title":"Import competitors from the AI report","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/competitors/import-ai-report","href":"/api-reference/competitors/import-competitors-from-the-ai-report"},{"title":"Get a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors/{id}","href":"/api-reference/competitors/get-a-competitor"},{"title":"Remove a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/competitors/{id}","href":"/api-reference/competitors/remove-a-competitor"},{"title":"Update a competitor","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/competitors/{id}","href":"/api-reference/competitors/update-a-competitor"},{"title":"Analyse a competitor's reviews","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/competitors/{id}/analysis","href":"/api-reference/competitors/analyse-a-competitors-reviews"},{"title":"Read a competitor's website again","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/competitors/{id}/refresh","href":"/api-reference/competitors/read-a-competitors-website-again"}]},{"group":"Contacts","pages":[{"title":"List and search contacts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts","href":"/api-reference/contacts/list-and-search-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts/{id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Archive a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/contacts/{id}","href":"/api-reference/contacts/archive-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/contacts/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"List sales pipeline stages","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pipeline-stages","href":"/api-reference/contacts/list-sales-pipeline-stages"},{"title":"List contact sources","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contact-sources","href":"/api-reference/contacts/list-contact-sources"},{"title":"List a track's members","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/progression-tracks/{id}/members","href":"/api-reference/contacts/list-a-tracks-members"},{"title":"Give members a rank","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/progression-tracks/{id}/ranks","href":"/api-reference/contacts/give-members-a-rank"},{"title":"Get a contact's ranks","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts/{contactId}/progression","href":"/api-reference/contacts/get-a-contacts-ranks"}]},{"group":"Content","pages":[{"title":"List content","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/content","href":"/api-reference/content/list-content"},{"title":"Create content","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/content","href":"/api-reference/content/create-content"},{"title":"Get published content by slug","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/content/{slug}","href":"/api-reference/content/get-published-content-by-slug"},{"title":"Delete content","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/content/{contentId}","href":"/api-reference/content/delete-content"},{"title":"Update content","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/content/{contentId}","href":"/api-reference/content/update-content"}]},{"group":"Custom Fields","pages":[{"title":"List contact custom fields","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/custom-fields","href":"/api-reference/custom-fields/list-contact-custom-fields"},{"title":"Create a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/custom-fields","href":"/api-reference/custom-fields/create-a-contact-custom-field"},{"title":"Get a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/custom-fields/{id}","href":"/api-reference/custom-fields/get-a-contact-custom-field"},{"title":"Delete a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/custom-fields/{id}","href":"/api-reference/custom-fields/delete-a-contact-custom-field"},{"title":"Update a contact custom field","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/custom-fields/{id}","href":"/api-reference/custom-fields/update-a-contact-custom-field"},{"title":"Get a contact's custom field values","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/contacts/{contactId}/custom-fields","href":"/api-reference/custom-fields/get-a-contacts-custom-field-values"},{"title":"Set a contact's custom field values","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/contacts/{contactId}/custom-fields","href":"/api-reference/custom-fields/set-a-contacts-custom-field-values"}]},{"group":"Document Rules","pages":[{"title":"List document rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/document-rules","href":"/api-reference/document-rules/list-document-rules"},{"title":"Create a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/document-rules","href":"/api-reference/document-rules/create-a-document-rule"},{"title":"Get a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/document-rules/{id}","href":"/api-reference/document-rules/get-a-document-rule"},{"title":"Delete a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/document-rules/{id}","href":"/api-reference/document-rules/delete-a-document-rule"},{"title":"Update a document rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/document-rules/{id}","href":"/api-reference/document-rules/update-a-document-rule"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/events","href":"/api-reference/events/list-events"},{"title":"Create an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events","href":"/api-reference/events/create-an-event"},{"title":"Get an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/events/{id}","href":"/api-reference/events/get-an-event"},{"title":"Delete an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/events/{id}","href":"/api-reference/events/delete-an-event"},{"title":"Update an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/events/{id}","href":"/api-reference/events/update-an-event"},{"title":"Publish an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/publish","href":"/api-reference/events/publish-an-event"},{"title":"Unpublish an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/unpublish","href":"/api-reference/events/unpublish-an-event"},{"title":"Cancel an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/cancel","href":"/api-reference/events/cancel-an-event"},{"title":"Duplicate an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/duplicate","href":"/api-reference/events/duplicate-an-event"},{"title":"List an event's attendees","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/events/{id}/bookings","href":"/api-reference/events/list-an-events-attendees"},{"title":"Register a customer for an event","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/events/{id}/bookings","href":"/api-reference/events/register-a-customer-for-an-event"}]},{"group":"External Programs","pages":[{"title":"List external programs","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/external-programs","href":"/api-reference/external-programs/list-external-programs"},{"title":"Create an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/external-programs","href":"/api-reference/external-programs/create-an-external-program"},{"title":"Get an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/external-programs/{id}","href":"/api-reference/external-programs/get-an-external-program"},{"title":"Delete an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/external-programs/{id}","href":"/api-reference/external-programs/delete-an-external-program"},{"title":"Update an external program","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/external-programs/{id}","href":"/api-reference/external-programs/update-an-external-program"}]},{"group":"Forms","pages":[{"title":"List forms","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/forms","href":"/api-reference/forms/list-forms"},{"title":"Create a form","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/forms","href":"/api-reference/forms/create-a-form"},{"title":"Get a form","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/forms/{id}","href":"/api-reference/forms/get-a-form"},{"title":"Update a form","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/forms/{id}","href":"/api-reference/forms/update-a-form"},{"title":"Set a fill-in form's questions","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/forms/{id}/questions","href":"/api-reference/forms/set-a-fill-in-forms-questions"}]},{"group":"Staff Roster","pages":[{"title":"List the staff roster","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-shifts","href":"/api-reference/staff-roster/list-the-staff-roster"},{"title":"Add a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-shifts","href":"/api-reference/staff-roster/add-a-shift"},{"title":"Get a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-shifts/{id}","href":"/api-reference/staff-roster/get-a-shift"},{"title":"Delete a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/instructor-shifts/{id}","href":"/api-reference/staff-roster/delete-a-shift"},{"title":"Edit a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructor-shifts/{id}","href":"/api-reference/staff-roster/edit-a-shift"},{"title":"Cancel a shift","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-shifts/{id}/cancel","href":"/api-reference/staff-roster/cancel-a-shift"},{"title":"List instructor time off","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-time-off","href":"/api-reference/staff-roster/list-instructor-time-off"},{"title":"Book a coach off","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-time-off","href":"/api-reference/staff-roster/book-a-coach-off"},{"title":"Remove instructor time off","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/instructor-time-off/{id}","href":"/api-reference/staff-roster/remove-instructor-time-off"},{"title":"Change instructor time off","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructor-time-off/{id}","href":"/api-reference/staff-roster/change-instructor-time-off"},{"title":"List rotation assignments","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-rotation-assignments","href":"/api-reference/staff-roster/list-rotation-assignments"},{"title":"Assign a coach to a rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/shift-rotation-assignments","href":"/api-reference/staff-roster/assign-a-coach-to-a-rotation"},{"title":"Remove a rotation assignment","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/shift-rotation-assignments/{id}","href":"/api-reference/staff-roster/remove-a-rotation-assignment"},{"title":"Update a rotation assignment","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/shift-rotation-assignments/{id}","href":"/api-reference/staff-roster/update-a-rotation-assignment"},{"title":"List shift rotations","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-rotations","href":"/api-reference/staff-roster/list-shift-rotations"},{"title":"Create a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/shift-rotations","href":"/api-reference/staff-roster/create-a-shift-rotation"},{"title":"Get a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-rotations/{id}","href":"/api-reference/staff-roster/get-a-shift-rotation"},{"title":"Delete a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/shift-rotations/{id}","href":"/api-reference/staff-roster/delete-a-shift-rotation"},{"title":"Update a shift rotation","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/shift-rotations/{id}","href":"/api-reference/staff-roster/update-a-shift-rotation"},{"title":"List shift templates","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-templates","href":"/api-reference/staff-roster/list-shift-templates"},{"title":"Create a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/shift-templates","href":"/api-reference/staff-roster/create-a-shift-template"},{"title":"Get a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/shift-templates/{id}","href":"/api-reference/staff-roster/get-a-shift-template"},{"title":"Delete a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/shift-templates/{id}","href":"/api-reference/staff-roster/delete-a-shift-template"},{"title":"Update a shift template","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/shift-templates/{id}","href":"/api-reference/staff-roster/update-a-shift-template"}]},{"group":"Instructors","pages":[{"title":"List instructor types","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-types","href":"/api-reference/instructors/list-instructor-types"},{"title":"Create an instructor type","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructor-types","href":"/api-reference/instructors/create-an-instructor-type"},{"title":"Get an instructor type","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructor-types/{id}","href":"/api-reference/instructors/get-an-instructor-type"},{"title":"Update an instructor type","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructor-types/{id}","href":"/api-reference/instructors/update-an-instructor-type"},{"title":"Reorder instructor types","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/instructor-types/order","href":"/api-reference/instructors/reorder-instructor-types"},{"title":"List and search instructors","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructors","href":"/api-reference/instructors/list-and-search-instructors"},{"title":"Create an instructor","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/instructors","href":"/api-reference/instructors/create-an-instructor"},{"title":"Get an instructor","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/instructors/{id}","href":"/api-reference/instructors/get-an-instructor"},{"title":"Update an instructor","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/instructors/{id}","href":"/api-reference/instructors/update-an-instructor"}]},{"group":"Invoices","pages":[{"title":"Summarize what was invoiced","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/invoices/summary","href":"/api-reference/invoices/summarize-what-was-invoiced"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Get an invoice","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/invoices/{id}","href":"/api-reference/invoices/get-an-invoice"}]},{"group":"Account","pages":[{"title":"Describe the API key's organization and granted scopes","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/me","href":"/api-reference/account/describe-the-api-keys-organization-and-granted-scopes"}]},{"group":"Media","pages":[{"title":"List media","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/media","href":"/api-reference/media/list-media"},{"title":"Register a file in the media library","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/media","href":"/api-reference/media/register-a-file-in-the-media-library"},{"title":"Get one media item","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/media/{mediaId}","href":"/api-reference/media/get-one-media-item"},{"title":"Delete a media item","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/media/{mediaId}","href":"/api-reference/media/delete-a-media-item"},{"title":"Update media metadata","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/media/{mediaId}","href":"/api-reference/media/update-media-metadata"}]},{"group":"Member Accounts","pages":[{"title":"List household and company accounts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/member-accounts","href":"/api-reference/member-accounts/list-household-and-company-accounts"},{"title":"Create a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/member-accounts","href":"/api-reference/member-accounts/create-a-household-or-company-account"},{"title":"Get a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/member-accounts/{id}","href":"/api-reference/member-accounts/get-a-household-or-company-account"},{"title":"Delete a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/member-accounts/{id}","href":"/api-reference/member-accounts/delete-a-household-or-company-account"},{"title":"Update a household or company account","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/member-accounts/{id}","href":"/api-reference/member-accounts/update-a-household-or-company-account"},{"title":"Add a member to an account","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/member-accounts/{id}/members","href":"/api-reference/member-accounts/add-a-member-to-an-account"},{"title":"Remove a member from an account","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/member-accounts/{id}/members/{contactId}","href":"/api-reference/member-accounts/remove-a-member-from-an-account"},{"title":"Change a member's role","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/member-accounts/{id}/members/{contactId}","href":"/api-reference/member-accounts/change-a-members-role"}]},{"group":"Memberships","pages":[{"title":"List memberships","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/memberships","href":"/api-reference/memberships/list-memberships"},{"title":"Create a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/memberships","href":"/api-reference/memberships/create-a-membership"},{"title":"Get a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/memberships/{id}","href":"/api-reference/memberships/get-a-membership"},{"title":"Update a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/memberships/{id}","href":"/api-reference/memberships/update-a-membership"},{"title":"Adjust a membership's sessions","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/memberships/{id}/session-adjustments","href":"/api-reference/memberships/adjust-a-memberships-sessions"},{"title":"Extend a membership","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/memberships/{id}/extensions","href":"/api-reference/memberships/extend-a-membership"}]},{"group":"Messages","pages":[{"title":"List messages","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/messages","href":"/api-reference/messages/list-messages"},{"title":"Create a message draft","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/messages","href":"/api-reference/messages/create-a-message-draft"},{"title":"Get a message","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/messages/{id}","href":"/api-reference/messages/get-a-message"},{"title":"Delete a message draft","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/messages/{id}","href":"/api-reference/messages/delete-a-message-draft"},{"title":"Update a message draft","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/messages/{id}","href":"/api-reference/messages/update-a-message-draft"}]},{"group":"Notifications","pages":[{"title":"Get notification settings","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/notification-settings","href":"/api-reference/notifications/get-notification-settings"},{"title":"Update a notification setting","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/notification-settings","href":"/api-reference/notifications/update-a-notification-setting"},{"title":"Apply notification settings to everyone in a role","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/notification-settings/apply","href":"/api-reference/notifications/apply-notification-settings-to-everyone-in-a-role"}]},{"group":"Pay Rate Policies","pages":[{"title":"List what coaches earned","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pay-ledger","href":"/api-reference/pay-rate-policies/list-what-coaches-earned"},{"title":"List pay rate policies","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pay-rate-policies","href":"/api-reference/pay-rate-policies/list-pay-rate-policies"},{"title":"Create a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pay-rate-policies","href":"/api-reference/pay-rate-policies/create-a-pay-rate-policy"},{"title":"Get a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pay-rate-policies/{id}","href":"/api-reference/pay-rate-policies/get-a-pay-rate-policy"},{"title":"Update a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/pay-rate-policies/{id}","href":"/api-reference/pay-rate-policies/update-a-pay-rate-policy"},{"title":"Put instructors on a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pay-rate-policies/{id}/instructors","href":"/api-reference/pay-rate-policies/put-instructors-on-a-pay-rate-policy"},{"title":"Take an instructor off a pay rate policy","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/pay-rate-policies/{id}/instructors/{instructorId}","href":"/api-reference/pay-rate-policies/take-an-instructor-off-a-pay-rate-policy"}]},{"group":"Payment Methods","pages":[{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/payment-methods","href":"/api-reference/payment-methods/list-payment-methods"},{"title":"Create a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/payment-methods","href":"/api-reference/payment-methods/create-a-payment-method"},{"title":"Get a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/payment-methods/{id}","href":"/api-reference/payment-methods/get-a-payment-method"},{"title":"Delete a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/payment-methods/{id}","href":"/api-reference/payment-methods/delete-a-payment-method"},{"title":"Update a payment method","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/payment-methods/{id}","href":"/api-reference/payment-methods/update-a-payment-method"}]},{"group":"Plans","pages":[{"title":"List membership plan categories","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plan-categories","href":"/api-reference/plans/list-membership-plan-categories"},{"title":"Create a membership plan category","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/plan-categories","href":"/api-reference/plans/create-a-membership-plan-category"},{"title":"Get a membership plan category","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plan-categories/{id}","href":"/api-reference/plans/get-a-membership-plan-category"},{"title":"Update a membership plan category","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/plan-categories/{id}","href":"/api-reference/plans/update-a-membership-plan-category"},{"title":"List and search membership plans","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plans","href":"/api-reference/plans/list-and-search-membership-plans"},{"title":"Create a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/plans","href":"/api-reference/plans/create-a-membership-plan"},{"title":"Get a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/plans/{id}","href":"/api-reference/plans/get-a-membership-plan"},{"title":"Delete a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/plans/{id}","href":"/api-reference/plans/delete-a-membership-plan"},{"title":"Update a membership plan","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/plans/{id}","href":"/api-reference/plans/update-a-membership-plan"}]},{"group":"Pricing Rules","pages":[{"title":"List pricing rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pricing-rules","href":"/api-reference/pricing-rules/list-pricing-rules"},{"title":"Create a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pricing-rules","href":"/api-reference/pricing-rules/create-a-pricing-rule"},{"title":"Quote a booking price","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/pricing-rules/quote","href":"/api-reference/pricing-rules/quote-a-booking-price"},{"title":"Get a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/pricing-rules/{id}","href":"/api-reference/pricing-rules/get-a-pricing-rule"},{"title":"Delete a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/pricing-rules/{id}","href":"/api-reference/pricing-rules/delete-a-pricing-rule"},{"title":"Update a pricing rule","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/pricing-rules/{id}","href":"/api-reference/pricing-rules/update-a-pricing-rule"}]},{"group":"Products","pages":[{"title":"List product categories","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/product-categories","href":"/api-reference/products/list-product-categories"},{"title":"Create a product category","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/product-categories","href":"/api-reference/products/create-a-product-category"},{"title":"Get a product category","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/product-categories/{id}","href":"/api-reference/products/get-a-product-category"},{"title":"Update a product category","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/product-categories/{id}","href":"/api-reference/products/update-a-product-category"},{"title":"List and search products","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/products","href":"/api-reference/products/list-and-search-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/products","href":"/api-reference/products/create-a-product"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/products/{id}","href":"/api-reference/products/get-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/products/{id}","href":"/api-reference/products/update-a-product"},{"title":"Get how many are left to sell","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/products/{id}/availability","href":"/api-reference/products/get-how-many-are-left-to-sell"}]},{"group":"Promotions","pages":[{"title":"List promotions","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/promotions","href":"/api-reference/promotions/list-promotions"},{"title":"Create a promotion","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/promotions","href":"/api-reference/promotions/create-a-promotion"},{"title":"Get a promotion","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/promotions/{id}","href":"/api-reference/promotions/get-a-promotion"},{"title":"Delete a promotion","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/promotions/{id}","href":"/api-reference/promotions/delete-a-promotion"},{"title":"Update a promotion","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/promotions/{id}","href":"/api-reference/promotions/update-a-promotion"}]},{"group":"Reports","pages":[{"title":"Revenue report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/revenue","href":"/api-reference/reports/revenue-report-for-a-period"},{"title":"Activity report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/activity","href":"/api-reference/reports/activity-report-for-a-period"},{"title":"Memberships report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/memberships","href":"/api-reference/reports/memberships-report-for-a-period"},{"title":"Members report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/members","href":"/api-reference/reports/members-report-for-a-period"},{"title":"What each report figure counts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/definitions","href":"/api-reference/reports/what-each-report-figure-counts"},{"title":"What one report figure counts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/definitions/{metric}","href":"/api-reference/reports/what-one-report-figure-counts"},{"title":"Tax report for a period","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/tax","href":"/api-reference/reports/tax-report-for-a-period"},{"title":"The sales behind the Tax report","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/tax/charges","href":"/api-reference/reports/the-sales-behind-the-tax-report"},{"title":"Who owes the organization, and for how long","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/amount-due","href":"/api-reference/reports/who-owes-the-organization-and-for-how-long"},{"title":"Every booking of a period and where its money stands","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/booking-audit","href":"/api-reference/reports/every-booking-of-a-period-and-where-its-money-stands"},{"title":"Who is at risk of leaving","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/at-risk","href":"/api-reference/reports/who-is-at-risk-of-leaving"},{"title":"Which memberships end soon","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/renewals","href":"/api-reference/reports/which-memberships-end-soon"},{"title":"Who is ready for their next rank","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/promotion-eligibility","href":"/api-reference/reports/who-is-ready-for-their-next-rank"},{"title":"Who cancels, how late, and where","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/reports/cancellations","href":"/api-reference/reports/who-cancels-how-late-and-where"}]},{"group":"Revenue Accounts","pages":[{"title":"List revenue accounts","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/revenue-accounts","href":"/api-reference/revenue-accounts/list-revenue-accounts"},{"title":"Create a revenue account","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/revenue-accounts","href":"/api-reference/revenue-accounts/create-a-revenue-account"},{"title":"Get a revenue account","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/revenue-accounts/{id}","href":"/api-reference/revenue-accounts/get-a-revenue-account"},{"title":"Update a revenue account","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/revenue-accounts/{id}","href":"/api-reference/revenue-accounts/update-a-revenue-account"}]},{"group":"Setup","pages":[{"title":"Get the club setup checklist","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/setup-checklist","href":"/api-reference/setup/get-the-club-setup-checklist"},{"title":"Mark a setup step","deprecated":null,"version":null,"openapi":"/openapi-platform.json put /v1/platform/setup-checklist/steps/{step}","href":"/api-reference/setup/mark-a-setup-step"}]},{"group":"Staff","pages":[{"title":"List staff","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/staff","href":"/api-reference/staff/list-staff"},{"title":"Change a staff member's role","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/staff/{userId}/role","href":"/api-reference/staff/change-a-staff-members-role"},{"title":"Get role permissions","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/role-permissions","href":"/api-reference/staff/get-role-permissions"},{"title":"Reset a role's permissions","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/role-permissions/{role}","href":"/api-reference/staff/reset-a-roles-permissions"},{"title":"Change a role's permissions","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/role-permissions/{role}","href":"/api-reference/staff/change-a-roles-permissions"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/tags","href":"/api-reference/tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/tags","href":"/api-reference/tags/create-a-tag"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/tags/{id}","href":"/api-reference/tags/delete-a-tag"},{"title":"Update a tag","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/tags/{id}","href":"/api-reference/tags/update-a-tag"},{"title":"Tag contacts","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/contact-tags/add","href":"/api-reference/tags/tag-contacts"},{"title":"Untag contacts","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/contact-tags/remove","href":"/api-reference/tags/untag-contacts"},{"title":"Get smart tag rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/smart-tag-settings","href":"/api-reference/tags/get-smart-tag-rules"},{"title":"Update smart tag rules","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/smart-tag-settings","href":"/api-reference/tags/update-smart-tag-rules"}]},{"group":"Templates","pages":[{"title":"List message templates","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates","href":"/api-reference/templates/list-message-templates"},{"title":"Create a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/templates","href":"/api-reference/templates/create-a-message-template"},{"title":"List the variables a template may use","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates/variables","href":"/api-reference/templates/list-the-variables-a-template-may-use"},{"title":"List the customizable system emails","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates/system","href":"/api-reference/templates/list-the-customizable-system-emails"},{"title":"Customize a system email","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/templates/system/{key}/copy","href":"/api-reference/templates/customize-a-system-email"},{"title":"Get a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/templates/{id}","href":"/api-reference/templates/get-a-message-template"},{"title":"Delete a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/templates/{id}","href":"/api-reference/templates/delete-a-message-template"},{"title":"Update a message template","deprecated":null,"version":null,"openapi":"/openapi-platform.json patch /v1/platform/templates/{id}","href":"/api-reference/templates/update-a-message-template"}]},{"group":"Transactions","pages":[{"title":"List transactions for the organization","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/transactions","href":"/api-reference/transactions/list-transactions-for-the-organization"},{"title":"Record a settlement","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions","href":"/api-reference/transactions/record-a-settlement"},{"title":"Get a transaction by ID","deprecated":null,"version":null,"openapi":"/openapi-platform.json get /v1/platform/transactions/{id}","href":"/api-reference/transactions/get-a-transaction-by-id"},{"title":"Delete an unpaid charge","deprecated":null,"version":null,"openapi":"/openapi-platform.json delete /v1/platform/transactions/{id}","href":"/api-reference/transactions/delete-an-unpaid-charge"},{"title":"Refund a settlement","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/refund","href":"/api-reference/transactions/refund-a-settlement"},{"title":"Void an unpaid charge","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/void","href":"/api-reference/transactions/void-an-unpaid-charge"},{"title":"Record a payment for a charge","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/record-payment","href":"/api-reference/transactions/record-a-payment-for-a-charge"},{"title":"Charge a charge to the member's saved card","deprecated":null,"version":null,"openapi":"/openapi-platform.json post /v1/platform/transactions/{id}/charge-saved-card","href":"/api-reference/transactions/charge-a-charge-to-the-members-saved-card"}]},{"group":"Website","pages":[{"title":"Get the website","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 booking - 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"]}