---
title: "Update patient form template"
method: PATCH
path: "/patient_form_templates/{id}"
tags: ["Patient Form Template"]
---

# Update patient form template

`PATCH /patient_form_templates/{id}`

## Path parameters

- `id` string, int64, required

## Request body

- object
  - `content` object, nullable
    - `sections` object[]
      - `name` string, nullable
      - `description` string, nullable
      - `questions` union[]
        - union
          - PatientFormTemplateQuestionText
            - `name` string, required
            - `required` boolean
            - `type` 'text', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field' | 'emergency_contact' | 'medicare_number' | 'medicare_reference_number' | 'occupation'
          - PatientFormTemplateQuestionParagraph
            - `answer` string
            - `name` string, required
            - `required` boolean
            - `type` 'paragraph', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field'
          - PatientFormTemplateQuestionAddress
            - `name` string, required
            - `required` boolean
            - `type` 'address', nullable, required
            - `patient_field_connection` 'address', required
          - PatientFormTemplateQuestionDate
            - `name` string, required
            - `required` boolean
            - `type` 'date', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field' | 'date_of_birth'
          - PatientFormTemplateQuestionEmail
            - `name` string, required
            - `required` boolean
            - `type` 'email', nullable, required
            - `patient_field_connection` 'email', required
          - PatientFormTemplateQuestionPhone
            - `name` string, required
            - `required` boolean
            - `type` 'phone', nullable, required
            - `patient_field_connection` 'phone', required
          - PatientFormTemplateQuestionPronouns
            - `name` string, required
            - `required` boolean
            - `type` 'pronouns', nullable, required
            - `patient_field_connection` 'pronouns', required
          - PatientFormTemplateQuestionSignature
            - `name` string, required
            - `required` boolean
            - `type` 'signature', nullable, required
          - PatientFormTemplateQuestionCheckboxes
            - `answers` object[] — Must be absent if `patient_field_connection` is `"custom_field"`
              - …
            - `other` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'checkboxes', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field'
          - PatientFormTemplateQuestionRadiobuttons
            - `answers` object[] — Must be absent if `patient_field_connection` is `"custom_field"`
              - …
            - `other` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'radiobuttons', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field'
          - PatientFormTemplateQuestionSelect
            - `name` string, required
            - `required` boolean
            - `type` 'select', nullable, required
            - `patient_field_connection` 'gender_identity' | 'sex', required
          - PatientFormTemplateQuestionFullName
            - `options` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'full_name', nullable, required
            - `patient_field_connection` 'full_name', required
  - `email_to_patient_on_completion` boolean, nullable
  - `name` string
  - `restricted_to_practitioner` boolean, nullable

## Response `200`

Resource was updated

- PatientFormTemplate
  - `archived_at` string, date-time, nullable
  - `content` object, nullable
    - `sections` object[]
      - `name` string, nullable
      - `description` string, nullable
      - `questions` union[]
        - union
          - PatientFormTemplateQuestionText
            - `name` string, required
            - `required` boolean
            - `type` 'text', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field' | 'emergency_contact' | 'medicare_number' | 'medicare_reference_number' | 'occupation'
          - PatientFormTemplateQuestionParagraph
            - `answer` string
            - `name` string, required
            - `required` boolean
            - `type` 'paragraph', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field'
          - PatientFormTemplateQuestionAddress
            - `name` string, required
            - `required` boolean
            - `type` 'address', nullable, required
            - `patient_field_connection` 'address', required
          - PatientFormTemplateQuestionDate
            - `name` string, required
            - `required` boolean
            - `type` 'date', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field' | 'date_of_birth'
          - PatientFormTemplateQuestionEmail
            - `name` string, required
            - `required` boolean
            - `type` 'email', nullable, required
            - `patient_field_connection` 'email', required
          - PatientFormTemplateQuestionPhone
            - `name` string, required
            - `required` boolean
            - `type` 'phone', nullable, required
            - `patient_field_connection` 'phone', required
          - PatientFormTemplateQuestionPronouns
            - `name` string, required
            - `required` boolean
            - `type` 'pronouns', nullable, required
            - `patient_field_connection` 'pronouns', required
          - PatientFormTemplateQuestionSignature
            - `name` string, required
            - `required` boolean
            - `type` 'signature', nullable, required
          - PatientFormTemplateQuestionCheckboxes
            - `answers` object[] — Must be absent if `patient_field_connection` is `"custom_field"`
              - …
            - `other` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'checkboxes', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field'
          - PatientFormTemplateQuestionRadiobuttons
            - `answers` object[] — Must be absent if `patient_field_connection` is `"custom_field"`
              - …
            - `other` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'radiobuttons', nullable, required
            - `custom_field_token` string, uuid — Required if `patient_field_connection` is `"custom_field"`
            - `patient_field_connection` 'custom_field'
          - PatientFormTemplateQuestionSelect
            - `name` string, required
            - `required` boolean
            - `type` 'select', nullable, required
            - `patient_field_connection` 'gender_identity' | 'sex', required
          - PatientFormTemplateQuestionFullName
            - `options` object
              - …
            - `name` string, required
            - `required` boolean
            - `type` 'full_name', nullable, required
            - `patient_field_connection` 'full_name', required
  - `created_at` string, date-time
  - `email_to_patient_on_completion` boolean, nullable
  - `id` string, int64
  - `links` object
    - `self` string, uri
  - `name` string
  - `restricted_to_practitioner` boolean, nullable
  - `updated_at` string, date-time

## Other responses

- `422` — Resource could not be saved due to validation errors

---

[API](https://skmtc.net/cliniko/apis/cliniko-api.md) · [All operations](https://skmtc.net/cliniko/apis/cliniko-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cliniko/cliniko-api/versions/c129a555ff44/schema)