For the complete documentation index, see llms.txt. This page is also available as Markdown.

Recurrent Bookings

Recurring booking schedules and templates.

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
coachTypestring[]Optional

Filter coaches by type

Example: ["HUMAN","ROBOT"]
Header parameters
user-agentstringRequired
Body
idstringRead-onlyRequired
typestring · enumRequiredPossible values:
statusstring · enumRead-onlyRequiredPossible values:
eventSubtypestring · enumRequiredPossible values:
eventCustomTypestringRequired
eventStatusstring · enumRequiredPossible values:
eventNamestringRequired
eventDescriptionstringRequired
totalTeamsnumber · nullableRequired
teamSizenumber · nullableRequired
maxGuestsnumber · nullableRequired
admissionstring · enumRequiredPossible values:
admissionKidsstring · enumRequiredPossible values:
coachRatenumberRequired
freeSignupCancellationHorizonHoursnumberRequired
tagsstring[]Required
visibilitystring · enumRequiredPossible values:
couponCodestring · nullableWrite-onlyRequired
virtualCreditsnumber · nullableWrite-onlyRequired
bookingModestring · enum · nullableWrite-onlyRequiredPossible values:
paymentMethodstring · enum · nullableWrite-onlyRequiredPossible values:
termsAgreedboolean · nullableWrite-onlyRequired

An optional parameter to tell the User is agreeing the "Terms" along with the booking request.

liabilityWaiverAgreedboolean · nullableWrite-onlyRequired

An optional parameter to tell the User is agreeing the "Liability waiver" along with the booking request.

createAsSeriesbooleanWrite-onlyRequired
chargeStrategystring · enum · nullableRequiredPossible values:
passesStrategystring · enum · nullableRequiredPossible values:
_linksobjectRequired
Responses
201

Returns a RecurrentBookingTaskDto with task ID for polling progress

application/json
idstringRead-onlyRequired
statusstring · enumRead-onlyRequiredPossible values:
totalItemsnumberRead-onlyRequired
completedItemsnumberRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
updatedDatestring · date-timeRead-onlyRequired
errorstring · nullableRead-onlyRequired
_linksobjectRead-onlyRequired
post/bookings/recurrences
POST /apis/v2/bookings/recurrences HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
user-agent: text
Content-Type: application/json
Accept: */*
Content-Length: 2064

{
  "type": "PREVIEW",
  "eventSubtype": "OPERATIONS",
  "eventCustomType": "text",
  "eventStatus": "DRAFT",
  "eventName": "text",
  "eventDescription": "text",
  "eventFeatures": [
    "WAITLIST"
  ],
  "tournamentDivision": {
    "provider": "SWISH",
    "swish": {
      "eventFormat": "rotating_partners_round_robin",
      "gameId": "game123",
      "editPlayersPath": "rotating-partners-round-robin"
    },
    "podplay": {
      "eventFormat": "round_robin",
      "gameId": "game123",
      "url": "https://tournaments.podplay.app/admin/tournaments/game123"
    },
    "lastSyncedAt": "2025-07-09T17:32:26.800Z",
    "visibility": "VISIBLE"
  },
  "totalTeams": 1,
  "teamSize": 1,
  "maxGuests": 1,
  "admission": "OPEN",
  "admissionRate": {
    "regular": 1,
    "membersDefault": 1,
    "memberships": {
      "items": [
        {
          "membership": {
            "id": "text"
          },
          "rate": 1
        }
      ],
      "_total": 1,
      "_links": {
        "self": {
          "href": "text"
        }
      }
    },
    "chargingStrategy": "spot+"
  },
  "admissionDate": {
    "regular": "2026-01-01T00:00:00.000Z",
    "membersDefault": "2026-01-01T00:00:00.000Z",
    "memberships": {
      "items": [
        {
          "membership": {
            "id": "text"
          },
          "date": "2026-01-01T00:00:00.000Z"
        }
      ],
      "_total": 1,
      "_links": {
        "self": {
          "href": "text"
        }
      }
    }
  },
  "admissionRating": {
    "minRating": 1,
    "maxRating": 1,
    "type": "text"
  },
  "admissionKids": "OPEN",
  "allowedMemberships": {
    "items": [
      "text"
    ],
    "_total": 1,
    "_links": {
      "self": {
        "href": "text"
      }
    }
  },
  "coachRate": 1,
  "freeSignupCancellationHorizonHours": 1,
  "picture": {
    "id": "text"
  },
  "tags": [
    "text"
  ],
  "visibility": "LISTED",
  "items": [
    {
      "session": {
        "id": "text"
      },
      "sessionTable": {
        "id": "text"
      },
      "sessionCoach": {
        "id": "text"
      },
      "sessionGuests": {
        "id": "text"
      }
    }
  ],
  "couponCode": "text",
  "virtualCredits": 1,
  "bookingMode": "USER_BOOKED",
  "paymentMethod": "CARD",
  "termsAgreed": true,
  "liabilityWaiverAgreed": true,
  "owner": {
    "id": "text"
  },
  "createAsSeries": true,
  "seriesPriceSettings": {
    "full": {
      "members": {
        "rate": 1,
        "overrides": {
          "items": [
            {
              "membership": {
                "id": "text"
              },
              "rate": 1,
              "_links": {}
            }
          ],
          "_total": 1
        }
      },
      "nonMembers": {
        "rate": 1
      }
    },
    "unit": {
      "members": {
        "rate": 1,
        "overrides": {
          "items": [
            {
              "membership": {
                "id": "text"
              },
              "rate": 1,
              "_links": {}
            }
          ],
          "_total": 1
        }
      },
      "nonMembers": {
        "rate": 1
      }
    }
  },
  "chargeStrategy": "BILL_SPLIT",
  "passesStrategy": "USE_ALL",
  "recurrence": {
    "id": "text",
    "cadence": "day",
    "daysOfWeek": [
      1
    ],
    "untilDate": "2026-01-01T00:00:00.000Z"
  },
  "_links": {}
}
{
  "id": "text",
  "status": "PENDING",
  "totalItems": 1,
  "completedItems": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "updatedDate": "2026-01-01T00:00:00.000Z",
  "result": {
    "recurrence": {
      "id": "text",
      "user": {
        "id": "text"
      },
      "createdDate": "2026-01-01T00:00:00.000Z",
      "cadence": "day",
      "daysOfWeek": [
        1
      ],
      "until": "2026-01-01T00:00:00.000Z",
      "events": {
        "items": [
          "text"
        ],
        "_total": 1,
        "_links": {
          "self": {
            "href": "text"
          }
        }
      },
      "_links": {}
    },
    "bookings": {
      "items": [
        "text"
      ],
      "_total": 1,
      "_links": {
        "self": {
          "href": "text"
        }
      }
    },
    "errors": [
      {
        "code": "text",
        "message": "text",
        "details": {}
      }
    ]
  },
  "error": "text",
  "_links": {}
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
taskIdstringRequired
Responses
200

Returns the current status of a recurrent booking task

application/json
idstringRead-onlyRequired
statusstring · enumRead-onlyRequiredPossible values:
totalItemsnumberRead-onlyRequired
completedItemsnumberRead-onlyRequired
createdDatestring · date-timeRead-onlyRequired
updatedDatestring · date-timeRead-onlyRequired
errorstring · nullableRead-onlyRequired
_linksobjectRead-onlyRequired
get/bookings/recurrences/tasks/{taskId}
GET /apis/v2/bookings/recurrences/tasks/{taskId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "id": "text",
  "status": "PENDING",
  "totalItems": 1,
  "completedItems": 1,
  "createdDate": "2026-01-01T00:00:00.000Z",
  "updatedDate": "2026-01-01T00:00:00.000Z",
  "result": {
    "recurrence": {
      "id": "text",
      "user": {
        "id": "text"
      },
      "createdDate": "2026-01-01T00:00:00.000Z",
      "cadence": "day",
      "daysOfWeek": [
        1
      ],
      "until": "2026-01-01T00:00:00.000Z",
      "events": {
        "items": [
          "text"
        ],
        "_total": 1,
        "_links": {
          "self": {
            "href": "text"
          }
        }
      },
      "_links": {}
    },
    "bookings": {
      "items": [
        "text"
      ],
      "_total": 1,
      "_links": {
        "self": {
          "href": "text"
        }
      }
    },
    "errors": [
      {
        "code": "text",
        "message": "text",
        "details": {}
      }
    ]
  },
  "error": "text",
  "_links": {}
}

Last updated

Was this helpful?