API Reference

Create an Event without recurrence

post
https://{booking_server}/partner/event-occurrence

Request to create an occurrence of an event/class to be consumed by 'Totalpass Students'.

⚠️ IMPORTANT: Except for 'bookingWindow', 'maxTimeToCancel', and 'externalReference', ALL fields in the payload are mandatory.

Booking Window Rules:

  1. If the 'bookingWindow' object is provided, BOTH 'minTimeToBook' and 'maxTimeToBook' become mandatory.
  2. Chronological Order: 'minTimeToBook' must be a date/time BEFORE 'maxTimeToBook'.
  3. Logical Flow:
    • minTimeToBook: The earliest a student can book.
    • maxTimeToBook: The deadline/cutoff for booking.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Title of the class/event.

string
required

Name of the responsible person.

integer
required

Duration of the class in minutes.

integer
required

Number of slots allocated for Totalpass Students.

integer
required

Numeric ID that represents the Gym Plan.

date
required

Start date of the occurrence duration* (format: 'YYYY-MM-DD').

bookingWindow
object

Booking window for the event. THIS IS NOT a required property

date

Maximum date and time that the user can cancel a reservation on this event, after that it will be considered a late cancel (format: 'YYYY-MM-DD 00:00 AM/PM')

string
required

Times when the event will start on the respective 'weekday', this property accepts only AM/PM hours format, like:'hh:mm PM'.

string
enum
required

Timezone of the event/class location. Possible values: 'pt-BR' and 'es-MX'.

Allowed:
integer

Numeric ID that represents the Seat Map.

string
enum

Event status, can be ACTIVE, INACTIVE or HIDDEN.

Allowed:
string

Description of the event/class.

string

This is a non-unique string field with a default value of null when not provided. It does not affect the current flow and is mainly used internally as a loose identifier for one or more events.

Headers
string
required

jwt used for authentication

Responses

Updated about 1 month ago

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

Updated about 1 month ago