---
title: "Update a lumabotFlow"
method: PUT
path: "/lumabotFlows/{lumabotFlowId}"
tags: ["lumabotFlows"]
---

# Update a lumabotFlow

`PUT /lumabotFlows/{lumabotFlowId}`

## Path parameters

- `lumabotFlowId` string, required

## Request body

- LumabotFlowRequest
  - `patient` string — the ID of the patient who filled out the answers for this form.
  - `status` 'started' | 'completed' — The completion status of the lumabot flow under the patient's perspective, knowingly: - `started`: when the patient started answering at least one question, but hasn't finished the form yet; - `completed`: the patient has finished answering all the questions and cannot edit the form anymore.
  - `flowType` 'welcome' | 'authenticate-patient' | 'speak-with-staff' | 'session-timeout' | 'knock-knock' | 'cul-de-sac' | 'feedback' | 'error' | 'no-availabilities' | 'regular' — type of the lumabot flow template
  - `completedAt` string, date-time — the date/time when the patient finished all the responses of this form.
  - `processingStatus` 'open' | 'in-progress' | 'closed' — The internal staff's management status for a completed flow, serving the purpose of organizing which answers were analysed by a staff member or not. - `open`: the flow was completed by a patient but not seen by any staff member yet; - `in-progress`: a staff user is analysing the answers; - `closed`: the flow has been completely analysed by a member of the staff team.
  - `processingStatusUpdatedBy` string — the ID of a staff `user` who analysed the responses of this completed flow and changed its `processingStatus`.
  - `processingStatusUpdatedAt` string, date-time — the date/time when a staff `user` analysed the responses of this completed flow and changed its `processingStatus`.
  - `appointment` string — the ID of an appointment related to this form.
  - `url` string — deprecated: custom lumabot flow url, basically to identify any patient in survey monkey, an external forms service that's not being used anymore by Luma.
  - `currentItemId` string — The code of the current question the patient was last shown, before answering it. Such a code must be the content of any `responses.page[0].questions[x].id`, or `success`. Usually this will contain each id, in sequence, but patients can go back and forth. Also, forms can have jump logic, and some questions might not be displayed to the patient. When the form is completed, this is updated to `success`.
  - `lumabotFlowTemplate` string — the ID of the template of questions that was displayed for the patient.
  - `lumabotFlowTemplateName` string — the name of the template of questions used as a basis for these form answers. See `lumabotFlowTemplates`.
  - `language` 'en' | 'es' | 'pt' — The language in which the form was answered by the patient.
  - `accessedFrom` string — IP address of the patient who filled out the form.
  - `previousLumabotFlow` string — PreviousLumabotFlow and nextLumabotFlow will be used to make it possible for forms to be able to jump to another form with another template so we can reduce the number of unecessary questions in a single form, which should help with organization and performance. One form must call the jump template, at which time we create a new lumabotFlow and set the previous form ID on its `previousLumabotFlow` property.
  - `nextLumabotFlow` string — PreviousLumabotFlow and nextLumabotFlow will be used to make it possible for forms to be able to jump to another form with another template so we can reduce the number of unecessary questions in a single form, which should help with organization and performance. One form must call the jump template, at which time we create a new lumabotFlow and set the new form ID on the first form's `nextLumabotFlow` property.
  - `questions` object[] — Contains information about the questions and answers given by the patient.
    - `answer` object
      - `id` string
      - `text` string
      - `createdAt` unknown
      - `details` object
    - `askedAt` unknown
    - `id` string
    - `type` string
    - `squiggly` string
    - `title` string
    - `redirectType` 'none' | 'goTo' | 'goToFlow' | 'goToPrevious' | 'isFinal' | 'externalUrl' | 'scheduler'
    - `redirectValue` string
    - `validations` object
      - `required` boolean
    - `properties` object
      - `template` string
  - `availabilities` string[] — availabilities
  - `facilities` string[] — facilities

## Response `200`

LumabotFlow

- LumabotFlowResponse — A LumabotFlow represents a single running or completed instance of a Lumabot conversational flow that a patient goes through, such as an intake form, appointment related questionnaire, or screening flow, generated from a LumabotFlowTemplate. It tracks the patient, the questions asked and answers given, current progress, completion status, and links to related records like appointments, offers, or availabilities produced as a result of the flow. It also supports chaining flows together and lets staff track a separate processing status for follow up after the patient completes the automated interaction.
  - `_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.
  - `patient` string — the ID of the patient who filled out the answers for this form.
  - `status` 'started' | 'completed' — The completion status of the lumabot flow under the patient's perspective, knowingly: - `started`: when the patient started answering at least one question, but hasn't finished the form yet; - `completed`: the patient has finished answering all the questions and cannot edit the form anymore.
  - `flowType` 'welcome' | 'authenticate-patient' | 'speak-with-staff' | 'session-timeout' | 'knock-knock' | 'cul-de-sac' | 'feedback' | 'error' | 'no-availabilities' | 'regular' — type of the lumabot flow template
  - `completedAt` string, date-time — the date/time when the patient finished all the responses of this form.
  - `processingStatus` 'open' | 'in-progress' | 'closed' — The internal staff's management status for a completed flow, serving the purpose of organizing which answers were analysed by a staff member or not. - `open`: the flow was completed by a patient but not seen by any staff member yet; - `in-progress`: a staff user is analysing the answers; - `closed`: the flow has been completely analysed by a member of the staff team.
  - `processingStatusUpdatedBy` string — the ID of a staff `user` who analysed the responses of this completed flow and changed its `processingStatus`.
  - `processingStatusUpdatedAt` string, date-time — the date/time when a staff `user` analysed the responses of this completed flow and changed its `processingStatus`.
  - `appointment` string — the ID of an appointment related to this form.
  - `url` string — deprecated: custom lumabot flow url, basically to identify any patient in survey monkey, an external forms service that's not being used anymore by Luma.
  - `currentItemId` string — The code of the current question the patient was last shown, before answering it. Such a code must be the content of any `responses.page[0].questions[x].id`, or `success`. Usually this will contain each id, in sequence, but patients can go back and forth. Also, forms can have jump logic, and some questions might not be displayed to the patient. When the form is completed, this is updated to `success`.
  - `lumabotFlowTemplate` string — the ID of the template of questions that was displayed for the patient.
  - `lumabotFlowTemplateName` string — the name of the template of questions used as a basis for these form answers. See `lumabotFlowTemplates`.
  - `language` 'en' | 'es' | 'pt' — The language in which the form was answered by the patient.
  - `accessedFrom` string — IP address of the patient who filled out the form.
  - `previousLumabotFlow` string — PreviousLumabotFlow and nextLumabotFlow will be used to make it possible for forms to be able to jump to another form with another template so we can reduce the number of unecessary questions in a single form, which should help with organization and performance. One form must call the jump template, at which time we create a new lumabotFlow and set the previous form ID on its `previousLumabotFlow` property.
  - `nextLumabotFlow` string — PreviousLumabotFlow and nextLumabotFlow will be used to make it possible for forms to be able to jump to another form with another template so we can reduce the number of unecessary questions in a single form, which should help with organization and performance. One form must call the jump template, at which time we create a new lumabotFlow and set the new form ID on the first form's `nextLumabotFlow` property.
  - `questions` object[] — Contains information about the questions and answers given by the patient.
    - `answer` object
      - `id` string
      - `text` string
      - `createdAt` unknown
      - `details` object
    - `askedAt` unknown
    - `id` string
    - `type` string
    - `squiggly` string
    - `title` string
    - `redirectType` 'none' | 'goTo' | 'goToFlow' | 'goToPrevious' | 'isFinal' | 'externalUrl' | 'scheduler'
    - `redirectValue` string
    - `validations` object
      - `required` boolean
    - `properties` object
      - `template` string
  - `availabilities` string[] — availabilities
  - `facilities` string[] — facilities

## 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)