POST/api/v1/s2s/providers
Create a provider
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/providers
- 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
Request-Body
Erforderlich- authIssuerstring (uri)
- Optional provider auth issuer. Omit with externalId to create an unlinked pending provider identity.
- Beispiel: https://login.example.org/realms/partner
- availabilityRulesarray
- Optional availability rules to create and generate slots for during provider creation. Referenced specialties are attached to the provider before rule creation.
- Beispiel: [{"dayOfWeek":1,"endTime":"12:00","generateFrom":"2026-07-01","generateTo":"2026-07-31","slotDuration":30,"specialtySlug":"adipositas","startTime":"08:30","timezone":"Europe/Berlin"}]
- availabilityRules[].dayOfWeekintegerErforderlich
- Weekday in JS/cron convention: 0 Sunday, 6 Saturday.
- Beispiel: 1
- availabilityRules[].endTimestringErforderlich
- End time in HH:mm.
- Beispiel: 12:00
- availabilityRules[].generateFromstring (date)Erforderlich
- First date for slot generation.
- Beispiel: 2026-05-13
- availabilityRules[].generateTostring (date)Erforderlich
- Last date for slot generation.
- Beispiel: 2026-06-12
- availabilityRules[].slotDurationinteger
- Slot duration in minutes.
- Beispiel: 30
- availabilityRules[].specialtySlugstringErforderlich
- Specialty slug.
- Beispiel: adipositas
- availabilityRules[].startTimestringErforderlich
- Start time in HH:mm.
- Beispiel: 08:30
- availabilityRules[].timezonestring
- IANA timezone.
- Beispiel: Europe/Berlin
- biostring
- Optional public profile bio.
- Beispiel: Facharzt für Innere Medizin.
- emailstring (email)Erforderlich
- Provider email.
- Beispiel: ben.koch@example.org
- externalIdstring
- Optional external identity subject or email. Must be supplied together with authIssuer when linking an IdP identity.
- Beispiel: ben.koch@example.org
- firstNamestringErforderlich
- First name.
- Beispiel: Ben
- lastNamestringErforderlich
- Last name.
- Beispiel: Koch
- organizationIdstring (uuid)Erforderlich
- Organization identifier.
- Beispiel: 37d0b63d-886d-4a71-875f-2cab61ca8e5e
- phonestring
- Optional phone.
- Beispiel: +49 151 12345678
- photoUrlstring (uri)
- Optional profile photo URL.
- Beispiel: https://example.com/ben-koch.jpg
- rolestringErforderlich
- Provider role.
- Beispiel: DOCTOR
- salutationstring
- Optional provider salutation code.
- Beispiel: MR
- specialtySlugsarray
- Optional specialty slugs to attach during provider creation.
- Beispiel: ["adipositas","diabetes"]
- titlestring
- Optional controlled provider title.
- Beispiel: Dr. med.
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