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

Update organization SMS confirmation 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/organizations/{organizationId}/sms-confirmation
Authentication
X-API-Key

Request

Parameters

organizationIdstring (uuid)pathRequired
organizationId path parameter.
Example: 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.
Example: 33333333-3333-4333-8333-333333333333

Request body

Required
enabledboolean
Optional organization switch; omission leaves the field unchanged.
reasonstringRequired
Required trimmed PHI-free justification. The reason is never stored, returned or logged; audit records reasonProvided only.
Example: SMS-Konfiguration 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-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.

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