POST/api/v1/s2s/pharmacy/rooms
Create partner pharmacy room
Published Partner endpoint from the stable OpenAPI 1.9.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/pharmacy/rooms
- Authentication
- X-API-Key
Request
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
Request body
Required- availabilityobjectRequired
- Initial weekly room availability rule. The room is created with this active rule.
- availability.dayOfWeekintegerRequired
- Weekday in JS/cron convention: 0 Sunday, 6 Saturday.
- Example: 1
- availability.endTimestringRequired
- End time in exact HH:mm format and strictly later than startTime. 24:00 is accepted as the end of the local day.
- Example: 12:00
- availability.startTimestringRequired
- Start time in exact HH:mm format. 24:00 is allowed only as endTime because endTime must be strictly later than startTime.
- Example: 08:00
- availability.timezonestring
- Optional canonical IANA timezone accepted by the runtime, such as Europe/Berlin.
- Example: Europe/Berlin
- availability.validFromstring (date)
- Optional first local date on which this room rule is valid.
- Example: 2026-06-01
- availability.validUntilstring (date)
- Optional inclusive last local date on which this room rule is valid. When validFrom is supplied, validUntil must be on or after validFrom. Null means open-ended.
- Example: 2026-12-31
- namestringRequired
- Room display name. Leading and trailing whitespace is removed; at least one non-whitespace character must remain.
- Example: Beratungsraum 1
- pharmacyOrgIdstring (uuid)Required
- Pharmacy organization identifier that owns the consultation room.
- Example: 37d0b63d-886d-4a71-875f-2cab61ca8e5e
Contract
The versioned OpenAPI contract is the authoritative source for parameters, request bodies, and response schemas.
Version
1.9.0
Expected response
201 Created