Enroll or register a guest for a class session by an Admin

This API helps you to enroll or register a guest for a class session by an Admin.

You must provide the appropriate details in the API request for the SessionId, GuestId, and BookingSrc parameters. Optionally, you can also specify the required details in the API request for various other parameters to filter the search results in the API response. Refer to the Request Body Parameters table for more information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Payment Object

NameTypeDescription
PaymentTypeenumIndicates the mode of payment used by the guest to pay for the class session registration: Cash - 0, GiftCard - 1, DiscoverCard - 2, Membership - 3, Maestro - 4, Mastercard - 5, CashBack - 6, DebitCard - 7, BCADebitCard - 8, DinersCard - 9, BCACreditCard - 10, Visa - 11, Amex - 12, LoyaltyPoints - 13, Custom - 14, Check - 15, PrepaidCard - 16, and Package - 17.
PaymentInstrumentIdguidUnique 32-character identifier of the payment instrument.
NamestringName of the payment method used by the guest.

Response Details

NameTypeDescription
SuccessbooleanIndicates whether the specified class session was successfully registered.
RegistrationIdintUnique identifier of the class session registration.
RegistrationStatusIdintUnique identifier of the status of registration of the class session registration.
MembershipBalanceobjectObject that contains these membership balance-related elements of the guest: MembershipName, BenefitName, BenefitId, Quantity, Frequency, ExpirationDays, Used, Notes, AllowDirectBooking, HasEquivalents, Balance, IsCategory, DiscountType, PeakDiscount, OffPeakDiscount, PostCreditPeakDiscount, PostCreditOffPeakDiscount, AllServices, and IsAddOn.
ErrorobjectObject that contains error message and error code details.
Query Params
int32
required

Mandatory ID of the class session to which the guest needs to be registered by an Admin.

string
required

Mandatory Unique 32-character identifier of the guest who is to be registered for a class session.

string

Optional Any notes or comments related to the class session registration of the guest.

string

Optional Object that contains all the payment-related elements for the class session registration. For more information, refer to the Payment Object table.

string
enum
required

Mandatory Source from which the class session is to be booked. The possible values for this parameter are: Store - 0, Mobile - 1, Web - 2, BookingWizardAdvancedMode - 3, BookingWizardBottomPanelMode - 4, Queue - 23, Kiosk - 24, KioskCMA - 25, KioskWeb - 26, ClassPass - 43, and FitnessKiosk - 44.

Allowed:
int32

Optional ID of the guest's class session registration.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json