arztkonsultationarztkonsultation Docs
API referencev1.9.0Deutsch

PATCH/api/v1/s2s/partners/pharmacies/{partnerOrgId}/kim-address

Update a partner pharmacy KIM address

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
PATCH
Endpoint
/api/v1/s2s/partners/pharmacies/{partnerOrgId}/kim-address
Authentication
X-API-Key

Request

Parameters

partnerOrgIdstringpathRequired
Partner-controlled pharmacy identifier from the registration call.
Example: pharmacy-4711
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
kimAddressone of
Omit to keep the current value, send null to remove it, or send a valid .kim.telematik address.
Example: team@praxis.kim.telematik
reasonstringRequired
Required trimmed PHI-free audit justification. The reason and KIM address are never stored in audit metadata.

Contract

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

Version

1.9.0

Expected response

200 OK

Download OpenAPI 1.9.0