Skip to main content
PATCH
Update an instructor type

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Path Parameters

id
integer
required

Body

application/json

Fields accepted when updating an instructor type. Send only what changes; null clears a nullable field, an omitted field is left alone, and at least one is required. A rename does not move slug. maxConcurrentBookings is the shape of the type; what a booking is checked against is each instructor's own value. maxPlayers is not: every instructor of the type reads it live, so changing it changes every one of their sessions.

name
string
Maximum string length: 255
slug
string

Stable key. Derived from the name when omitted; send one only when something outside 1club already refers to it. An explicit slug that clashes is a 409, and a rename never moves it.

Maximum string length: 120
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
description
string | null
Maximum string length: 2000
revenueAccountId
integer | null

Where a session with a coach of this kind posts, from GET /v1/platform/revenue-accounts. Leave it unset and the sale posts to whichever account the organization has marked default, resolved at the time of the sale.

maxConcurrentBookings
integer
default:1

How many one-to-one sessions a coach of this kind may hold in the same slot.

Required range: 1 <= x <= 100
maxPlayers
integer
default:1

How many people one session with a coach of this kind may bring, the person booking included. 1 is one-to-one. A session with them and no area may be booked for any group up to this; a session on an area takes the area's own player limit instead.

Required range: 1 <= x <= 20

Response

The updated instructor type

A kind of coach the organization has. Reference the id as instructorTypeId on an instructor. One shape for the list, get-by-id, create and update.

id
integer
name
string
slug
string

Stable key, derived from the name when a create does not send one. A rename never moves it.

sortOrder
integer

Position in the order staff set in Settings, 1 first. Lists come back in this order; change it with the type's PUT .../order.

description
string | null
revenueAccountId
integer | null

Where a session with a coach of this kind posts. Null falls back to the organization's default account.

instructorCount
integer

Coaches currently filed under this type, active and retired.

createdAt
string<date-time>
updatedAt
string<date-time>
maxConcurrentBookings
integer

How many one-to-one sessions a coach of this kind may hold in the same slot. What a booking is actually checked against is the instructor's own value; this is the shape of the type, not an override.

maxPlayers
integer

How many people one session with a coach of this kind may bring, the person booking included. 1 is one-to-one. A session with them and no area may be booked for any group up to this; a session on an area takes the area's own player limit instead.