arztkonsultationarztkonsultation Docs
API referencev1.0.0Deutsch

PATCH/api/v1/s2s/pharmacy/rooms/{roomId}/availability-rules/{ruleId}

Update partner pharmacy room 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
PATCH
Endpoint
/api/v1/s2s/pharmacy/rooms/{roomId}/availability-rules/{ruleId}
Authentication
X-API-Key

Request

Parameters

roomIdstring (uuid)pathRequired
Pharmacy consultation room identifier.
Example: ac7515a2-0cf6-4f73-b20b-3b96f3c97c9d
ruleIdstring (uuid)pathRequired
Availability rule identifier.
Example: 7d8f9f4e-0d2f-4f10-8e80-6fd2a884fd21
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
startTimestringRequired
Start time in HH:mm.
Example: 08:00
timezonestring
Optional IANA timezone.
Example: Europe/Berlin
validFromstring (date)
Optional first local date on which this room rule is valid.
Example: 2026-06-01
validUntilstring (date)
Optional last local date on which this room rule is valid. Null means open-ended.
Example: 2026-12-31

Contract

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

Version

1.0.0

Expected response

200 OK

Download OpenAPI 1.0.0