Natzar Partner API Reference - v1.0.0
    Preparing search index...

    Interface TenantCapabilities

    What this tenant is allowed to offer, so your UI can hide what isn't enabled instead of discovering it through a 409 feature_disabled.

    Always the EFFECTIVE answer: the tenant's own configuration AND your API key's, ANDed together. A key can only narrow its tenant, never widen it, so nothing here can claim more than a create would actually allow.

    interface TenantCapabilities {
        asyncEnabled: boolean;
        telehealthEnabled: boolean;
        modalities: {
            async: ModalityCapabilities;
            telehealth: ModalityCapabilities;
            in_person: ModalityCapabilities;
        };
    }
    Index
    asyncEnabled: boolean

    Whether async (messaging) consults exist on this tenant for this key — i.e. modalities.async.enabled. This is the flag feature_disabled answers to; whether YOU may create one on demand is modalities.async.onDemandLive.

    telehealthEnabled: boolean

    Whether telehealth (video) consults exist on this tenant for this key — i.e. modalities.telehealth.enabled. As above: onDemandLive (queue) and onDemandBook (scheduled) are what a create is gated on.

    modalities: {
        async: ModalityCapabilities;
        telehealth: ModalityCapabilities;
        in_person: ModalityCapabilities;
    }

    The full matrix, per modality. Added after the two booleans above, which remain present and correct — /v1 only ever grows.

    in_person is the third modality (a real appointment at a clinic). It has no live mode by definition and no creation endpoint on /v1 yet; it is published so a UI can already tell a patient the clinic sees people in person.