POST/api/v1/s2s/pharmacy/rooms/closures
Close one, several or all rooms for a range
Published Partner endpoint from the stable OpenAPI 1.10.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/closures
- 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- allRoomsboolean
- All active rooms of the pharmacy. Exclusive with roomIds.
- Example: true
- fromstring (date)Required
- First date.
- Example: 2026-10-19
- holidayCodestring
- Municipal holiday suggested for the stored state. With it from must equal to and reasonCode must be absent.
- Example: CORPUS_CHRISTI
- impactVersionstring
- SHA-256 impact version from a preview or a previous response. Optional for partners: without it the write proceeds; a stale value yields 409 ROOM_CALENDAR_IMPACT_STALE.
- Example: 00fa1de975d61372e9fb9919cdd0b999e2b5e301795a6ab403e2692b5bfe6162
- pharmacyOrgIdstring (uuid)Required
- Pharmacy organization (required).
- Example: 37d0b63d-886d-4a71-875f-2cab61ca8e5e
- reasonCodestring
- Fixed reason code. No free text exists. Treat unknown values as unrecognized instead of failing; values may be added in a minor release.
- Example: VACATION
- roomIdsarray
- Rooms of the pharmacy, 1 to 50. Exactly one of roomIds or allRooms.
- tostring (date)Required
- Last date, at most 366 days after from.
- Example: 2026-10-21
Contract
The versioned OpenAPI contract is the authoritative source for parameters, request bodies, and response schemas.
Version
1.10.0
Expected response
201 Created