---
title: "Delete a patientFormTemplate"
method: DELETE
path: "/patientFormTemplates/{patientFormTemplateId}"
tags: ["patientFormTemplates"]
---

# Delete a patientFormTemplate

`DELETE /patientFormTemplates/{patientFormTemplateId}`

## Path parameters

- `patientFormTemplateId` string, required

## Response `200`

Deleted patientFormTemplate

- PatientFormTemplateResponse — A form template is the reusable definition of a form that staff configure once and then send to many patients, such as intake, pre-qualification, feedback, or consent forms. It defines the form content, jump logic for branching between questions, optional insurance and reminder settings, and custom scripts used to calculate results, map answers to EHR fields, or intercept scheduler requests when the form leads into booking an appointment. Each time a patient fills it out, a separate patient form instance is created from this template.
  - `_id` string — Luma's internal ID of an object.
  - `user` string — The ID of the root account user.
  - `deleted` 0 | 1 — Flag for logical deletion where 1 means deleted.
  - `createdBy` string — The ID of the user who created this object.
  - `updatedBy` string — The ID of the user who updated this object.
  - `createdAt` string, date-time — The date/time when this object was created.
  - `updatedAt` string, date-time — The date/time when this object was updated.
  - `source` 'system' | 'user' — source of the patient form template
  - `externalId` object — externalId of the patient form template
    - `source` 'docusign' | 'hellosign' | 'surveymonkey' | 'luma'
    - `id` string
  - `title` string — title of the patient form template
  - `description` string — description of the patient form template
  - `insurance` object — insurance of the patient form template
    - `enabled` boolean
    - `id` string
  - `reminder` object — reminder of the patient form template
    - `enabled` boolean
    - `id` string
  - `type` 'pre-qualification' | 'intake' | 'feedback' | 'ccda' — type of the patient form template
  - `active` boolean — describes if the patient form template is active
  - `url` string — url of the patient form template
  - `tag` string — tag of the patient form template which is used to build the squiggly
  - `template` object — template of the patient form template
    - `version` string
    - `welcomeScreens` object[]
      - `id` string
      - `template` string
      - `title` string
      - `properties` object
        - `template` string
        - `actionLabel` string
    - `items` object[]
      - `id` string
      - `type` string
      - `squiggly` string
      - `title` string
      - `redirectType` string
      - `validations` object
        - `required` boolean
      - `properties` object
        - `addToAppointment` boolean
        - `showCustomAction` boolean
        - `includeNoneOfAboveChoice` boolean
        - `allowOtherChoice` boolean
        - `scoringEnabled` boolean
        - `visibility` string
        - `allowMultipleSelection` boolean
        - `showDescription` boolean
        - `answers` object
          - `id` string
          - `redirectType` string
  - `integratorMapping` string — integratorMapping of the patient form template
  - `calculation` string — calculation of the patient form template
  - `finalDispositionCalculation` string — finalDispositionCalculation of the patient form template
  - `schedulerRequestInterceptor` string — schedulerRequestInterceptor of the patient form template
  - `schedulerResponseInterceptor` string — schedulerResponseInterceptor of the patient form template
  - `htmlPdfTemplateHeader` string — htmlPdfTemplateHeader of the patient form template
  - `htmlPdfTemplateBody` string — htmlPdfTemplateBody of the patient form template
  - `htmlPdfTemplateFooter` string — htmlPdfTemplateFooter of the patient form template
  - `lumabot` boolean — lumabot of the patient form template
  - `sendToDirectMessageEmail` boolean — sendToDirectMessageEmail of the patient form template
  - `lumaBotFlow` 'welcome' | 'authenticate-patient' | 'speak-with-staff' | 'session-timeout' | 'knock-knock' | 'cul-de-sac' | 'feedback' — lumaBotFlow of the patient form template

## Other responses

- `401` — Not authenticated
- `403` — Access token does not have the required scope

---

[API](https://skmtc.net/lumahealth/apis/rest-service.md) · [All operations](https://skmtc.net/lumahealth/apis/rest-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lumahealth/rest-service/revisions/d3c75c2a2f1d/schema)