Use Cases

Get Use Case Schema

Return JSON schemas plus defaults & example payload for a specific use case.

get/integrations/v1/use-cases/{use_case}/schema

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/integrations/v1/use-cases/{use_case}/schema
  • Auth
    HTTP bearer

Path parameters

use_case'NEW_PATIENT_APPOINTMENT_REMINDER' | 'LAB_REMINDER' | 'REFERRAL' | 'FINAL_APPOINTMENT_NOTIFICATION' required

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 21 revisions of this API.