PATCH/api/v1/s2s/scheduling/providers/{providerId}/availability-rules/{ruleId}

Update partner provider availability rule

Published Partner endpoint from the stable OpenAPI 1.0.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/providers/{providerId}/availability-rules/{ruleId}
Authentication
X-API-Key

Request

Parameters

providerIdstring (uuid)pathRequired
Provider identifier.
Example: 5cd4f03b-5c1d-406e-b834-35b4f635c1c3
ruleIdstring (uuid)pathRequired
Availability rule identifier.
Example: 7d8f9f4e-0d2f-4f10-8e80-6fd2a884fd21
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
dayOfWeekinteger
Optional replacement weekday in JS/cron convention: 0 Sunday, 6 Saturday.
Example: 1
endTimestring
Optional replacement end time in HH:mm.
Example: 13:00
generateFromstring (date)
Optional first date for slot regeneration. Must be sent together with generateTo.
Example: 2026-06-01
generateTostring (date)
Optional last date for slot regeneration. Must be sent together with generateFrom.
Example: 2026-06-30
slotDurationinteger
Optional replacement slot duration in minutes.
Example: 30
specialtySlugstring
Optional replacement specialty slug. The provider must already have this specialty.
Example: adipositas
startTimestring
Optional replacement start time in HH:mm.
Example: 10:00
timezonestring
Optional replacement IANA timezone.
Example: Europe/Berlin

Contract

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

Version

1.0.0

Expected response

200 OK

Download OpenAPI 1.0.0