Sign in
latestOpenAPI 3.0.22026-07-26480119.6 KB

bc65b4950c7e

Partner::Individual Events

Create an Event without recurrence

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.
post/partner/event-occurrence

Parameters

#/paths/~1partner~1events/get/parameters/0 — unresolved $ref

Request body

titlestring required

Title of the class/event.

responsiblestring required

Name of the responsible person.

durationinteger required

Duration of the class in minutes.

slotsinteger required

Number of slots allocated for Totalpass Students.

planIdinteger required

Numeric ID that represents the Gym Plan.

eventDatestring date required

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

maxTimeToCancelstring 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')

startTimestring time required

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

timezone'pt-BR' | 'es-MX' required

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

seatMapIdinteger

Numeric ID that represents the Seat Map.

status'ACTIVE' | 'INACTIVE' | 'HIDDEN'

Event status, can be ACTIVE, INACTIVE or HIDDEN.

descriptionstring

Description of the event/class.

externalReferencestring

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.

Example request

{
  "title": "Yoga",
  "responsible": "Cisne",
  "duration": 45,
  "slots": 1,
  "planId": 1,
  "timezone": "es-MX",
  "eventDate": "2023-09-06",
  "description": "A Yoga melhora o funcionamento do coração, pois regula a circulação sanguínea e o sistema nervoso, além de equilibrar o sistema endócrino, controlando os níveis de hormônios do estresse."
}

Response

Created a event

object required