Book an appointment booking

Required Scopes: APPOINTMENTS_WRITE

Book an appointment booking for given customer

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
customerId
required
integer <int64>

Unique ID of the customer

bookableAppointmentId
required
integer <int64>

Unique ID of the bookable appointment

startDateTime
required
string <date-time>

Start date time of the bookable appointment slot

endDateTime
required
string <date-time>

End date time of the bookable appointment slot

instructorIds
Array of integers <int64>

Instructor ID list of the bookable appointment slot

Responses
200

OK

400

Validation of the request failed.

401

Authentication failed. No api-key, wrong api-key or wrong header name.

403

Authorization failed. The caller has no privilege to the given resource.

404

Entity does not exists.

409

Conflict

429

Access denied - rate limit is exceeded.

500

Unexpected system error.

post/v1/appointments/booking/book
Request samples
application/json
{
  • "customerId": 203,
  • "bookableAppointmentId": 20334,
  • "startDateTime": "2022-06-22T08:00:00.000+02:00[Europe/Berlin]",
  • "endDateTime": "2022-06-22T10:00:00.000+02:00[Europe/Berlin]",
  • "instructorIds": [
    ]
}
Response samples
application/json
{
  • "bookingId": 2033,
  • "bookingStatus": "BOOKED",
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "endDateTime": "2019-08-24T14:15:22Z",
  • "title": "Mission Beach body",
  • "duration": 45,
  • "category": "Fitness",
  • "description": "Get your body ready for beaches",
  • "imgUrl": "string",
  • "instructors": [
    ],
  • "appointmentStatus": "COMPLETED",
  • "participantStatus": "PARTICIPATING"
}