PATCH/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/email-message-settings

Update appointment-type email message settings

Published Partner endpoint from the stable OpenAPI 1.9.0 contract.

Overview

Use this endpoint only with a Partner API key. Code samples use placeholders and the public sandbox URL.

Method
PATCH
Endpoint
/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/email-message-settings
Authentication
X-API-Key

Request

Parameters

appointmentTypeIdstring (uuid)pathRequired
appointmentTypeId path parameter.
Example: 0d316943-1a82-4c6f-8b6d-72f0fc823c8b
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
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.
reasonstringRequired
Required trimmed PHI-free justification. The reason is never stored, returned or logged; audit records reasonProvided only.
Example: 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.
revisionstringRequired
Opaque SHA-256 base64url revision from the latest read. A stale value returns 409 and must be reconciled before retrying.
Example: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA

Contract

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

Version

1.9.0

Expected response

200 OK

Download OpenAPI 1.9.0