POST/api/v1/s2s/organizations

Create an organization

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/organizations
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

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

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/organizations \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: {PARTNER_API_KEY}' \
  --data '{"email":"kontakt@mvz-preview.example.org","name":"MVZ Preview","parentOrgId":"37d0b63d-886d-4a71-875f-2cab61ca8e5e","phone":"+49 30 123456","slug":"mvz-preview","type":"MVZ"}'

Response scenario