POST/api/v1/s2s/bookings
Create a booking
Freigegebener Partner-Endpunkt aus dem stabilen OpenAPI-1.0.0-Vertrag.
Übersicht
Nutzen Sie den Endpunkt ausschließlich mit einem Partner-API-Schlüssel. Die Codebeispiele verwenden Platzhalter und die öffentliche Sandbox-Adresse.
- Methode
- POST
- Endpunkt
- /api/v1/s2s/bookings
- Authentifizierung
- X-API-Key
Anfrage
Parameter
- X-Correlation-IDstringheader
- Optional opaque request correlation ID for tracing API calls across systems. Billing audit paths persist only UUIDv4-shaped values and drop free-form values.
- Beispiel: 33333333-3333-4333-8333-333333333333
- Idempotency-Keystringheader
- Optional idempotency key for safe retries of booking creation.
- Beispiel: booking-create-2026-05-13-001
Request-Body
Erforderlich- appointmentTypeSlugstring
- Optional selected appointment type slug. When supplied, it must be active for the selected slot provider organization and specialty.
- Beispiel: adipositas-erstberatung
- externalPatientRefstringErforderlich
- External patient reference from the integrating system.
- Beispiel: patient-12345
- intakeResponsesobject
- Appointment-type-specific intake answers keyed by custom intake field key. Required custom fields are validated against the selected appointment type.
- Beispiel: {"companion-count":1,"visit-reason":"Erstberatung zur Adipositas-Therapie"}
- patientEmailstring (email)
- Optional patient email.
- patientNamestring
- Optional patient display name.
- patientPhonestring
- Optional patient phone.
- slotIdstring (uuid)Erforderlich
- Slot to book.
- Beispiel: 0d6b61b1-a99e-480c-878f-b8f5d1be0983
Vertrag
Der versionierte OpenAPI-Vertrag ist die verbindliche Quelle für Parameter, Request-Body und Response-Schemas.
Version
1.0.0
Erwartete Antwort
201 Created