PATCH/api/v1/s2s/scheduling/organizations/{organizationId}/sms-confirmation

Update organization SMS confirmation configuration

Freigegebener Partner-Endpunkt aus dem stabilen OpenAPI-1.9.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
PATCH
Endpunkt
/api/v1/s2s/scheduling/organizations/{organizationId}/sms-confirmation
Authentifizierung
X-API-Key

Anfrage

Parameter

organizationIdstring (uuid)pathErforderlich
organizationId path parameter.
Beispiel: 37d0b63d-886d-4a71-875f-2cab61ca8e5e
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
enabledboolean
Optional organization switch; omission leaves the field unchanged.
reasonstringErforderlich
Required trimmed PHI-free justification. The reason is never stored, returned or logged; audit records reasonProvided only.
Beispiel: SMS-Konfiguration abgestimmt.
revisionstring (date-time)Erforderlich
Expected revision from the latest read. A stale value returns 409 and must be reconciled before retrying.
Beispiel: 2026-09-16T08:30:00.000Z
textstring
Optional normalized single-segment GSM-7 text. Null restores inheritance; omission leaves the field unchanged. Runtime validation counts extension characters as two septets and rejects control characters, placeholders, URLs, query fragments and credential syntax.

Vertrag

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

Version

1.9.0

Erwartete Antwort

200 OK

OpenAPI 1.9.0 herunterladen