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

Update appointment-type email reminder configuration

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-reminder
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
enabledboolean
Optional explicit switch. Null restores inheritance; omission leaves the field unchanged.
leadMinutesinteger
Optional lead time in minutes. Null restores inheritance; omission leaves the field unchanged.
reasonstringRequired
Required trimmed PHI-free justification. The reason is never stored, returned or logged; audit records reasonProvided only.
Example: E-Mail-Erinnerung abgestimmt.
revisionstring (date-time)Required
Expected revision from the latest read. A stale value returns 409 and must be reconciled before retrying.
Example: 2026-09-17T08:30:00.000Z

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