latestOpenAPI 3.0.22026-07-26480119.6 KB

bc65b4950c7e

Partner::Events

Create an Event

Request to create events/classes to be consumed by 'Totalpass Students'. All fields in the payload are mandatory.

post/partner/events

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.

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

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

startDatestring date required

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

endDatestring date required

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

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.

Example request

{
  "title": "Yoga",
  "responsible": "Cisne",
  "duration": 45,
  "slots": 1,
  "planId": 1,
  "seatMapId": null,
  "timezone": "es-MX",
  "startDate": "2023-09-06",
  "endDate": "2023-09-07",
  "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.",
  "frequencyOptions": [
    {
      "weekday": 4,
      "startTime": [
        "15:00"
      ]
    },
    {
      "weekday": 3,
      "startTime": [
        "15:00"
      ]
    }
  ]
}

Response

Created a event

object required