POST/api/v1/s2s/appointments/{appointmentId}/cancel
Cancel partner appointment
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/appointments/{appointmentId}/cancel
- Authentifizierung
- X-API-Key
Anfrage
Parameter
- appointmentIdstring (uuid)pathErforderlich
- Tenant-local appointment reference: either the Booking id (UUID) or the video call id (sessionRef) delivered in the appointment payload.
- Beispiel: 8cb6d8b8-a582-4cd2-8095-f60537a0d3dc
- 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
Request-Body
Erforderlich- reasonCodestringErforderlich
- Required closed PHI-free cancellation reason code. Free-text reasons, diagnoses, medical notes and patient contact data are rejected.
- Beispiel: ADMINISTRATIVE
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