arztkonsultationarztkonsultation Docs
API referencev1.0.0Deutsch

POST/api/v1/s2s/scheduling/providers/{providerId}/availability-rules

Create partner provider availability rule

Published Partner endpoint from the stable OpenAPI 1.0.0 contract.

Overview

Use this endpoint only with a Partner API key. Code samples use placeholders and the public sandbox URL.

Method
POST
Endpoint
/api/v1/s2s/scheduling/providers/{providerId}/availability-rules
Authentication
X-API-Key

Request

Parameters

providerIdstring (uuid)pathRequired
Provider identifier.
Example: 5cd4f03b-5c1d-406e-b834-35b4f635c1c3
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

Request body

Required
dayOfWeekintegerRequired
Weekday in JS/cron convention: 0 Sunday, 6 Saturday.
Example: 1
endTimestringRequired
End time in HH:mm.
Example: 12:00
generateFromstring (date)Required
First date for slot generation.
Example: 2026-05-13
generateTostring (date)Required
Last date for slot generation.
Example: 2026-06-12
slotDurationinteger
Slot duration in minutes.
Example: 30
specialtySlugstringRequired
Specialty slug.
Example: adipositas
startTimestringRequired
Start time in HH:mm.
Example: 08:30
timezonestring
IANA timezone.
Example: Europe/Berlin
rulesarrayRequired
Availability rules to create in one transaction.
Example: [{"dayOfWeek":1,"endTime":"12:00","generateFrom":"2026-07-01","generateTo":"2026-07-31","slotDuration":30,"specialtySlug":"adipositas","startTime":"08:30","timezone":"Europe/Berlin"},{"dayOfWeek":3,"endTime":"17:00","generateFrom":"2026-07-01","generateTo":"2026-07-31","slotDuration":30,"specialtySlug":"adipositas","startTime":"14:00","timezone":"Europe/Berlin"}]
rules[].dayOfWeekintegerRequired
Weekday in JS/cron convention: 0 Sunday, 6 Saturday.
Example: 1
rules[].endTimestringRequired
End time in HH:mm.
Example: 12:00
rules[].generateFromstring (date)Required
First date for slot generation.
Example: 2026-05-13
rules[].generateTostring (date)Required
Last date for slot generation.
Example: 2026-06-12
rules[].slotDurationinteger
Slot duration in minutes.
Example: 30
rules[].specialtySlugstringRequired
Specialty slug.
Example: adipositas
rules[].startTimestringRequired
Start time in HH:mm.
Example: 08:30
rules[].timezonestring
IANA timezone.
Example: Europe/Berlin

Contract

The versioned OpenAPI contract is the authoritative source for parameters, request bodies, and response schemas.

Version

1.0.0

Expected response

201 Created

Download OpenAPI 1.0.0