POST/api/v1/s2s/organizations

Create an organization

Freigegebener Partner-Endpunkt aus dem stabilen OpenAPI-1.0.0-Vertrag.

Übersicht

Nutzen Sie den Endpunkt ausschließlich mit einem Partner-API-Schlüssel. Die Codebeispiele verwenden Platzhalter und die öffentliche Sandbox-Adresse.

Methode
POST
Endpunkt
/api/v1/s2s/organizations
Authentifizierung
X-API-Key

Anfrage

Parameter

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.
Beispiel: 33333333-3333-4333-8333-333333333333

Request-Body

Erforderlich
emailstring (email)
Optional public email.
Beispiel: kontakt@mvz-preview.example.org
namestringErforderlich
Organization display name.
Beispiel: MVZ Preview
parentOrgIdstring (uuid)
Optional parent organization. Required pattern: a PHARMACY organization may reference a PHARMACY_CHAIN parent.
Beispiel: 37d0b63d-886d-4a71-875f-2cab61ca8e5e
phonestring
Optional public phone.
Beispiel: +49 30 123456
slugstringErforderlich
Organization slug.
Beispiel: mvz-preview
typestringErforderlich
Organization type.
Beispiel: MVZ

Vertrag

Der versionierte OpenAPI-Vertrag ist die verbindliche Quelle für Parameter, Request-Body und Response-Schemas.

Version

1.0.0

Erwartete Antwort

201 Created

OpenAPI 1.0.0 herunterladen