Skip to main content
A pass group is a category of entry passes — for example a 10-entry card and an unlimited pass sold separately. A client holds a balance per group, and an entry granted into one group cannot be spent in another. Fetch the groups from GET /v1/pass-groups to discover the id you pass as passGroupId when granting entries.

​
The default group

Every studio has one. It is the active group with the lowest order, then the lowest id. An archived group is never the default, even when its order is lower. Omitting passGroupId — or sending null — grants into the default group. This is the behavior integrations written before multi-group support relied on, and it still works unchanged.
name is null for a studio’s original default group, which was created before groups had names. Fall back to a label of your own rather than rendering an empty string.

​
Active and archived

Both states are returned. An archived group is hidden in Zenamu’s public booking widgets, but clients may still hold a balance in it, and you can still top that balance up. Filter archived groups out of anything you offer for sale; keep them when you display a client’s existing balances.

​
Targeting a group

A passGroupId that names a group from another studio, or one that does not exist, is rejected with 400. On bulk grants it is resolved per item, so one bad ID fails only that item. Targeting a non-default group also requires the multi-category entitlement on the studio’s plan. Without it, only the default group is available — omit passGroupId, send null, or send the default group’s ID. See Handling errors.
​
id
integer

Pass this as passGroupId when granting entry passes.

​
name
string | null

Group name. null for a studio's original default group.

​
order
integer

Display order. The active group with the lowest order, then the lowest id, is the studio default. An archived group is never the default.

​
state
enum<string>
Available options:
active,
archived