POST/api/v1/s2s/pharmacy/rooms/{roomId}/exceptions/{exceptionId}/retract

Retract a room exception

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/{roomId}/exceptions/{exceptionId}/retract
Authentication
X-API-Key

Request

Parameters

roomIdstring (uuid)pathRequired
Pharmacy consultation room identifier.
Example: ac7515a2-0cf6-4f73-b20b-3b96f3c97c9d
exceptionIdstring (uuid)pathRequired
Room exception group identifier.
Example: 4c1b8f9e-1d1f-4e3f-9a4b-6a2f1f0b2c11
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
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

Contract

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

Version

1.10.0

Expected response

201 Created

Download OpenAPI 1.10.0