Create a family booking with children

  • Booking
  • Booking
  • 4 routes
How do I create a family booking that includes children?

This scenario documents a family booking journey with children, from proposal search to attendee qualification and booking creation. It is useful when the booking flow must handle child birthdates, household composition and post-booking attendee verification.

The flow creates a family proposal, updates the proposal attendees, creates the booking and then retrieves the booked attendees list.

Overview

This scenario helps a booking application manage a family booking where one or more children must be identified correctly throughout the proposal and booking flow.

Prerequisites

  • A valid x-api-key, and where required accept-language and authorization.
  • Family composition and child birthdates ready to be sent in the booking flow.
  • The accept-language used for booking creation must stay consistent with the proposal creation context.

Expected result

The application can create a family proposal, identify the attendees, create the booking and read back the attendees linked to the booking.

Process workflow

Legend:
Mandatory
Optional
1

Create a family proposal

Mandatory

Use POST/v3/proposals/search to create a family proposal.

Prerequisites

Prepare the parameters required by the call. Keep x-api-key and, when the route is customer-scoped, a valid bearer token. Validate the request body before the call to avoid a validation error.

Calling CURL

curl -X POST \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: en-US" \
  -H "Content-Type: application/json" \
  -d '{"product_id": "product-1", "start_date": "2026-07-05", "end_date": "2026-07-12", "attendees": [{"birthdate": "1990-03-12"}]}' \
  "https://api.clubmed.com/v3/proposals/search"

Example answer

[
  {
    "id": "proposal-1",
    "product_id": "product-1",
    "price": {
      "amount": 2890,
      "currency": "EUR"
    },
    "remaining_stock": 4
  }
]

info: Keep the returned proposal_id to add attendees, attach services, or continue the family booking flow.

Response codes

  • 200 OK: the operation succeeds and the resource is returned.
  • 400 Bad Request: the body or parameters are invalid.
  • 404 Not Found: the target resource cannot be found.
POST/v3/proposals/search
See more
2

Identify family attendees

Mandatory

Use PUT/v3/proposals/{proposal_id}/attendees to identify family attendees.

Prerequisites

Prepare proposal_id. Keep x-api-key and, when the route is customer-scoped, a valid bearer token. Validate the request body before the call to avoid a validation error.

Calling CURL

curl -X PUT \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: en-US" \
  -H "Content-Type: application/json" \
  -d '{"attendees": [{"id": "attendee-1", "first_name": "Jane", "last_name": "Doe", "birthdate": "1990-03-12"}]}' \
  "https://api.clubmed.com/v3/proposals/{proposal_id}/attendees"

Example answer

HTTP/1.1 204 No Content

info: Success may be returned without a response body. Read the resource again afterwards if you need to display the final state.

Response codes

  • 204 No Content: the operation is applied successfully.
  • 400 Bad Request: the body or parameters are invalid.
  • 404 Not Found: the target resource cannot be found.
PUT/v3/proposals/{proposal_id}/attendees
See more
3

Create the family booking

Mandatory

Use POST/v3/bookings to create the family booking once the proposal attendees have been qualified with the children's data.

Prerequisites

Prepare the parameters required by the call. Keep x-api-key and, when the route is customer-scoped, a valid bearer token. Validate the request body before the call to avoid a validation error.

Calling CURL

curl -X POST \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: en-US" \
  -H "Content-Type: application/json" \
  -d '{"proposal_id": "proposal-1"}' \
  "https://api.clubmed.com/v3/bookings"

Example answer

{
  "booking_id": "booking-1",
  "booking_status": "OPTION",
  "payment_status": "PENDING"
}

info: Keep the returned booking_id to continue with attendee verification or follow-up payment steps.

Response codes

  • 200 OK: the operation succeeds and the resource is returned.
  • 400 Bad Request: the body or parameters are invalid.
  • 404 Not Found: the target resource cannot be found.
POST/v3/bookings
See more
4

Retrieve booking attendees

Mandatory

Use GET/v0/bookings/{booking_id}/attendees to verify that each adult and child is correctly attached to the created family booking.

Prerequisites

Prepare booking_id. Keep x-api-key and, when the route is customer-scoped, a valid bearer token.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: en-US" \
  "https://api.clubmed.com/v0/bookings/{booking_id}/attendees"

Example answer

[
  {
    "id": "attendee-1",
    "first_name": "Jane",
    "type": "ADULT"
  }
]

info: Use this read-back to confirm that each child and adult is attached to the right booking.

Response codes

  • 200 OK: the expected data is returned.
  • 400 Bad Request: the request is invalid or incomplete.
  • 404 Not Found: the requested resource cannot be found.
GET/v0/bookings/{booking_id}/attendees
See more