POST/api/v1/s2s/partners/pharmacies/{partnerOrgId}/offboarding-requests

Request partner pharmacy offboarding

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: POST
Endpoint: /api/v1/s2s/partners/pharmacies/{partnerOrgId}/offboarding-requests
Authentication: X-API-Key

Request

Parameters

partnerOrgIdstring (uuid)pathRequired: 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

effectiveAtstring (date-time): Optional requested effective date.; Example: 2026-08-01T00:00:00.000Z
reasonstring: Optional PHI-free termination reason from the partner system.; Example: Vertrag beendet

Contract

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

Version

1.0.0

Expected response

201 Created

Download OpenAPI 1.0.0

Simulated sandbox

Language

cURL

curl --request POST \
  --url https://sandbox.arztkonsultation.io/api/v1/s2s/partners/pharmacies/example-partnerOrgId/offboarding-requests \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: {PARTNER_API_KEY}' \
  --data '{"effectiveAt":"2026-08-01T00:00:00.000Z","reason":"Vertrag beendet"}'

Response scenario