PATCH/api/v1/s2s/scheduling/organizations/{organizationId}/email-message-settings

Update organization email message settings

Freigegebener Partner-Endpunkt aus dem stabilen OpenAPI-1.10.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}/email-message-settings
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
confirmationAdditionalTextstring
Additional confirmation text. Null selects inheritance. Normalized text is additionally limited to 8 lines and 4096 UTF-8 bytes and accepts only the documented placeholders.
confirmationIntroTextstring
Confirmation introduction text. Null selects inheritance. Normalized text is additionally limited to 8 lines and 4096 UTF-8 bytes and accepts only the documented placeholders.
logoVisibilitystring
Configured logo visibility, or null to inherit.
reasonstringErforderlich
Required trimmed PHI-free justification. The reason is never stored, returned or logged; audit records reasonProvided only.
Beispiel: E-Mail-Texte abgestimmt.
reminderAdditionalTextstring
Additional reminder text. Null selects inheritance. Normalized text is additionally limited to 8 lines and 4096 UTF-8 bytes and accepts only the documented placeholders.
reminderIntroTextstring
Reminder introduction text. Null selects inheritance. Normalized text is additionally limited to 8 lines and 4096 UTF-8 bytes and accepts only the documented placeholders.
revisionstringErforderlich
Opaque SHA-256 base64url revision from the latest read. A stale value returns 409 and must be reconciled before retrying.
Beispiel: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

Vertrag

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

Version

1.10.0

Erwartete Antwort

200 OK

OpenAPI 1.10.0 herunterladen