Skip to content
API Docs/
API Reference
/
/
Update Form

Update Form

Request

Update an existing form template, replacing all fields.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
form_typestringrequired
Enum:"questionnaire""response""appointment""care_navigation""intake_form""structured_consult"
titlestringrequired
descriptionstringrequired
patient_titlestring or nullrequired
patient_descriptionstring or nullrequired
confirmation_messagestring or nullrequired
snomed_codestring or nullrequired
fieldsArray of objects, non-emptyrequired
curl -i -X PUT \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/forms/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "form_type": "questionnaire",
    "title": "string",
    "description": "string",
    "patient_title": "string",
    "patient_description": "string",
    "confirmation_message": "string",
    "snomed_code": "string",
    "fields": [
      {
        "name": "string",
        "type": "string",
        "observation_name": "systolic_blood_pressure",
        "problem_name": "asthmatic",
        "immunisation_name": "administration_of_men_a_c_w135_and_y_vaccine",
        "hint": "string",
        "optional": true,
        "text": "string",
        "snomed_code": "string",
        "options": [
          {
            "value": "string",
            "snomed_code": "string"
          }
        ],
        "validation": {
          "date_range_validation": "unrestricted"
        },
        "conditions": {
          "display_condition": "show_when",
          "cond_type": "is equal to",
          "cond_value": "string",
          "order": "string",
          "condition_sequential_id": "string"
        },
        "defaultValue": "string",
        "attachment_url": "string",
        "order": "string",
        "sequential_id": "string"
      }
    ]
  }'

Responses

Ok

Bodyapplication/json
idstringrequired
Response
{
  "id": "string"
}