PATCH/api/v1/s2s/scheduling/appointment-types/{appointmentTypeId}/intake-fields
Replace appointment-type intake fields
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}/intake-fields
- 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- fieldsarrayRequired
- Complete ordered custom-field array. Empty clears fields. At most 61,440 UTF-8 bytes of canonical normalized JSON; unrelated intakeConfig properties are preserved.
- fields[].typeobject
- fields[].validationobject
- fields[].validation.maxLengthinteger
- Text/textarea only. Inclusive maximum Unicode code-point count after NFC and trim; at most 240 for text, 4,000 for textarea.
- fields[].validation.minLengthinteger
- Text/textarea only. Inclusive minimum Unicode code-point count after NFC and trim; at most 240 for text, 4,000 for textarea. Must not exceed maxLength.
- fields[].validation.patternIdstring
- Text/textarea only; complete matches. DIGITS: ASCII digits; ALPHANUMERIC: Unicode letters/numbers, space, dot, hyphen, underscore, slash; GERMAN_POSTAL_CODE: five ASCII digits; EMAIL: stable ASCII email; PHONE_E164: + and 8–15 digits, first 1–9; ISO_DATE: YYYY-MM-DD and a real calendar date. Arbitrary regexes are forbidden.
- fields[].validation.maximumnumber
- Number only, finite inclusive upper bound.
- fields[].validation.minimumnumber
- Number only, finite inclusive lower bound; must not exceed maximum.
- reasonstringRequired
- Required PHI-free justification: 5–500 Unicode code points after trimming. Wire superset: OpenAPI 3 cannot express trim-before-length; the runtime enforces normalized limits, while the complete raw PATCH body is limited to 65,536 bytes. Never persisted, returned or logged; audit records reasonProvided only.
- revisionstringRequired
- Opaque base64url revision of normalized custom fields. Return the latest read value unchanged; stale revisions produce 409. It is not a credential and does not describe the whole appointment type.
Contract
The versioned OpenAPI contract is the authoritative source for parameters, request bodies, and response schemas.
Version
1.9.0
Expected response
200 OK