Create a provider

Parameters

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.

Example: 33333333-3333-4333-8333-333333333333

authIssuerstring (uri)

Optional provider auth issuer. Omit with externalId to create an unlinked pending provider identity.

Example: 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.

Example: [{"dayOfWeek":1,"endTime":"12:00","generateFrom":"2026-07-01","generateTo":"2026-07-31","slotDuration":30,"specialtySlug":"adipositas","startTime":"08:30","timezone":"Europe/Berlin"}]

availabilityRules[].dayOfWeekintegerRequired

Weekday in JS/cron convention: 0 Sunday, 6 Saturday.

Example: 1

availabilityRules[].endTimestringRequired

End time in HH:mm.

Example: 12:00

availabilityRules[].generateFromstring (date)Required

First date for slot generation.

Example: 2026-05-13

availabilityRules[].generateTostring (date)Required

Last date for slot generation.

Example: 2026-06-12

availabilityRules[].slotDurationinteger

Slot duration in minutes.

Example: 30

availabilityRules[].specialtySlugstringRequired

Specialty slug.

Example: adipositas

availabilityRules[].startTimestringRequired

Start time in HH:mm.

Example: 08:30

availabilityRules[].timezonestring

IANA timezone.

Example: Europe/Berlin

biostring

Optional public profile bio.

Example: Facharzt für Innere Medizin.

emailstring (email)Required

Provider email.

Example: ben.koch@example.org

externalIdstring

Optional external identity subject or email. Must be supplied together with authIssuer when linking an IdP identity.

Example: ben.koch@example.org

firstNamestringRequired

First name.

Example: Ben

lastNamestringRequired

Last name.

Example: Koch

organizationIdstring (uuid)Required

Organization identifier.

Example: 37d0b63d-886d-4a71-875f-2cab61ca8e5e

phonestring

Optional phone.

Example: +49 151 12345678

photoUrlstring (uri)

Optional profile photo URL.

Example: https://example.com/ben-koch.jpg

rolestringRequired

Provider role.

Example: DOCTOR

salutationstring

Optional provider salutation code.

Example: MR

specialtySlugsarray

Optional specialty slugs to attach during provider creation.

Example: ["adipositas","diabetes"]

titlestring

Optional controlled provider title.

Example: Dr. med.