---
id: flows-instances-partial-update
title: "flows_instances_partial_update"
description: "Flow Viewset"
sidebar_label: "flows_instances_partial_update"
hide_title: true
hide_table_of_contents: true
api: eJztWG1v2zYQ/iuEsA8bZkdZ2gGbPy1L0y5AugZJ2g/rMoGWzhYbitRIyolj6L/vjpRsKZadFuiKAesXWxRf7u65517EVaRLMNwJrc6yaBLNpL6ziVDWcZWCTUpunOAyqcqMO4hGUQY2NaKkDbj8JS5n7wTcWXA4iat5AQ6MjSbvV5GgJSV3OU4pnMCRldUcRzbNoeDRZBW5ZenfOyPUfOv8d8KKqQQmFHM5sLeX5wdRPYoM/F0JA6iwMxXUN6PI8TnJDPpHN2EJWPerzpYkJtXKgXL0yMtSitSbHH+wJGa1rY+efoDUDdt7BQYhEQ9gyGRDADoBlnYHK7etKoQ6BzVHJCY/oP4ehSeWfQwUuIPftzt+PCQHOESflv/1fszHD8fjPw7HPyc3339DsDnh5JPqPZZ7les7xbj1Uq/pBFLBA1HyOVjvENwi5oqHLQixlG9mngKgqoL8wivcrlyDO4qkF9qIh3Ys1AIxzdohKKOlLMhlo6hSvaGBVC/ALIlH6HdI0LkzMa8Cjcn5j+1rDPfue7FR9ZSUI/b0LX4BqcA37C7nDq0WNliL/5WFjM20OWAvtWFwz4tSwsgjc9wzkM2aHUhSJGqK52g8DxBIxSo17sCBJ+Kxhi3Qv86ydubW41pqpOoyQd8IBUmhM+++NahSEpJquc/mC3/EqT/hNR2Ax6a6QKaIqZDCLdfHNidMtZbA1Rb3TxUn/vX2Mto7QkKkBrhFzPqzd8LlyBJr77TJWMEVestYhvgUGpcAy2Ah0oZDki915br2oXfTW4zyURu+iYSZ6wyNmOc0tuivKTftdDsM00/w4dyLDVQgk5WALOHpbioXYG3DOidURUmxedVo5l/ukfrCyzhO91DwpGE0BBLaXFcyYzmmLqRQ4FGgmNcXWZMiipZIxj2bPKCPYm7QGKUVROuEmvR42XlfqV0ztsL0RyI77xDPUtu9yPfDZQcKl02aZxIWIJmesb5JGEwZ6yUSj0DAIgCEQNSdWOAOE31Gbr8M9QGnaYGFtDLIWI/NOgRxdFP7WmJLrWxI8UeHh1+woJS3Q/kaU1DBUXZUVSI4g2dvlFyGetjnN/Nr1rlkKlSGh1DcyqR0JsHJT5ZQj3ZUuj217ctVs6/16z9Tv6aYwOdGV2qQZH21X4FruUDS6HGznYkCkTpgZzM/Qewj9WIEELVgaA0+GZTvS07uXPmnEi5Y4CqjUEtux8IOUdk7wXYU5MZw8o5wUNino6MeONMHm/jcp6Yc0wrSpQqJpzlAYCaa+9yxDahfS5nTb81Y6I93Kfw/6TTgvtTGJZWRH8fKsN4TE33kMRyC8GsD87WB+ZcamM0H7/tuTu1nhH4Z69G8qdcj6ic6yWlfUzBaf6uH9NiaftNnX+T7p77Z5Lvnn7VNereurezUGD3w4a1VMhMgswRo/hPybu2zVDbUzBAFs0yQWC4vuvI6PeVGtaDZTjyefUY8XoHCnjFlxxdnOwDJwHExkN/2WtulWXNAx92N0D1m1pRJkM1ZuPdJc38nRO1cFPvKE69vluIV0auOiWBgFu2Vkc/JUcxLES+exT6k2t78irAJxnU69LUZVPPbmyVfXIAbMF4nQvdycx90GvqezX3NJrpD87od7d3isGkUt7vCoSraFM+hShi69bZudMrFoyw+lLIfJ8eQCWvqRGfa49LovgFrFBHOYfXR4dHzg58Ojrao9ZrfoqmPE5UVBNlBUyBQL1/mCk+xKAcp9S9zven9hPZf9Fhx8bOpA/Trs2vqh72TyWF2EsdzLN3V9ADxiTtHxJunqdTTGEWp+Pzs5PT3q1PvVErQWOc7h3uGsTXDWHN3yYbvLjux+Pgas2GUg3sXlxIFkzFNtxDo3F40EtqNOHyeNBmTgian+oHrVqsptitvjaxreo0kNPSViY8Ljl99U3IR8j4Tlp4xcGZcWtij67dtUfmO7VK1TXyK0h5+llQ0wsdbWLZXsPUNrsuxg8EQIflh6iRIGV/TAZutW5mqHrU7jrFWlW7v2ptOUrg4vj75DVdPm2vZJkIM9w0V/no9tTfbR7p/t8IQUfOKGpRJFA6tm/ag202GgB+1D2TWIBLoEr/iWt+CQre0wDgaEzJ1/Q/amRdR
sidebar_class_name: "patch api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"flows_instances_partial_update"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/flows/instances/{slug}/"}
>
  
</MethodEndpoint>



Flow Viewset

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<details
  style={{"marginBottom":"1rem"}}
  className={"openapi-markdown__details"}
  data-collapsed={false}
  open={true}
>
  <summary
    style={{}}
  >
    <h3
      className={"openapi-markdown__details-summary-header-params"}
    >
      Path Parameters
    </h3>
  </summary><div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{"in":"path","name":"slug","schema":{"type":"string","description":"Visible in the URL."},"required":true}}
      >
        
      </ParamsItem>
    </ul>
  </div>
</details><MimeTabs
  className={"openapi-tabs__mime"}
>
  <TabItem
    label={"application/json"}
    value={"application/json-schema"}
  >
    <details
      style={{}}
      className={"openapi-markdown__details mime"}
      data-collapsed={false}
      open={true}
    >
      <summary
        style={{}}
        className={"openapi-markdown__details-summary-mime"}
      >
        <h3
          className={"openapi-markdown__details-summary-header-body"}
        >
          Body
        </h3>
      </summary><div
        style={{"textAlign":"left","marginLeft":"1rem"}}
      >
        
      </div><ul
        style={{"marginLeft":"1rem"}}
      >
        <SchemaItem
          collapsible={false}
          name={"name"}
          required={false}
          schemaName={"string"}
          qualifierMessage={"**Possible values:** `non-empty`"}
          schema={{"type":"string","minLength":1}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"slug"}
          required={false}
          schemaName={"string"}
          qualifierMessage={"**Possible values:** `non-empty` and `<= 50 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
          schema={{"type":"string","minLength":1,"description":"Visible in the URL.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"title"}
          required={false}
          schemaName={"string"}
          qualifierMessage={"**Possible values:** `non-empty`"}
          schema={{"type":"string","minLength":1,"description":"Shown as the Title in Flow pages."}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"designation"}
          required={false}
          schemaName={"FlowDesignationEnum (string)"}
          qualifierMessage={"**Possible values:** [`authentication`, `authorization`, `invalidation`, `enrollment`, `unenrollment`, `recovery`, `stage_configuration`]"}
          schema={{"enum":["authentication","authorization","invalidation","enrollment","unenrollment","recovery","stage_configuration"],"type":"string","title":"FlowDesignationEnum"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"policy_engine_mode"}
          required={false}
          schemaName={"PolicyEngineMode (string)"}
          qualifierMessage={"**Possible values:** [`all`, `any`]"}
          schema={{"enum":["all","any"],"type":"string","title":"PolicyEngineMode"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"compatibility_mode"}
          required={false}
          schemaName={"boolean"}
          qualifierMessage={undefined}
          schema={{"type":"boolean","description":"Enable compatibility mode, increases compatibility with password managers on mobile devices."}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"layout"}
          required={false}
          schemaName={"FlowLayoutEnum (string)"}
          qualifierMessage={"**Possible values:** [`stacked`, `content_left`, `content_right`, `sidebar_left`, `sidebar_right`]"}
          schema={{"enum":["stacked","content_left","content_right","sidebar_left","sidebar_right"],"type":"string","title":"FlowLayoutEnum"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"denied_action"}
          required={false}
          schemaName={"DeniedActionEnum (string)"}
          qualifierMessage={"**Possible values:** [`message_continue`, `message`, `continue`]"}
          schema={{"enum":["message_continue","message","continue"],"type":"string","title":"DeniedActionEnum"}}
        >
          
        </SchemaItem><SchemaItem
          collapsible={false}
          name={"authentication"}
          required={false}
          schemaName={"AuthenticationEnum (string)"}
          qualifierMessage={"**Possible values:** [`none`, `require_authenticated`, `require_unauthenticated`, `require_superuser`, `require_outpost`]"}
          schema={{"enum":["none","require_authenticated","require_unauthenticated","require_superuser","require_outpost"],"type":"string","title":"AuthenticationEnum"}}
        >
          
        </SchemaItem>
      </ul>
    </details>
  </TabItem>
</MimeTabs><div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"200"}
        value={"200"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"pk"}
                        required={true}
                        schemaName={"uuid"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","format":"uuid","readOnly":true,"title":"Flow uuid"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"policybindingmodel_ptr_id"}
                        required={true}
                        schemaName={"uuid"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","format":"uuid","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"name"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"slug"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={"**Possible values:** `<= 50 characters`, Value must match regular expression `^[-a-zA-Z0-9_]+$`"}
                        schema={{"type":"string","description":"Visible in the URL.","maxLength":50,"pattern":"^[-a-zA-Z0-9_]+$"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"title"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Shown as the Title in Flow pages."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"designation"}
                        required={true}
                        schemaName={"FlowDesignationEnum (string)"}
                        qualifierMessage={"**Possible values:** [`authentication`, `authorization`, `invalidation`, `enrollment`, `unenrollment`, `recovery`, `stage_configuration`]"}
                        schema={{"enum":["authentication","authorization","invalidation","enrollment","unenrollment","recovery","stage_configuration"],"type":"string","title":"FlowDesignationEnum"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"background"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Get the URL to the background image. If the name is /static or starts with http\nit is returned as-is","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"stages"}
                        required={true}
                        schemaName={"uuid[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string","format":"uuid"},"readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"policies"}
                        required={true}
                        schemaName={"uuid[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string","format":"uuid"},"readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"cache_count"}
                        required={true}
                        schemaName={"integer"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer","description":"Get count of cached flows","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"policy_engine_mode"}
                        required={false}
                        schemaName={"PolicyEngineMode (string)"}
                        qualifierMessage={"**Possible values:** [`all`, `any`]"}
                        schema={{"enum":["all","any"],"type":"string","title":"PolicyEngineMode"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"compatibility_mode"}
                        required={false}
                        schemaName={"boolean"}
                        qualifierMessage={undefined}
                        schema={{"type":"boolean","description":"Enable compatibility mode, increases compatibility with password managers on mobile devices."}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"export_url"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string","description":"Get export URL for flow","readOnly":true}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"layout"}
                        required={false}
                        schemaName={"FlowLayoutEnum (string)"}
                        qualifierMessage={"**Possible values:** [`stacked`, `content_left`, `content_right`, `sidebar_left`, `sidebar_right`]"}
                        schema={{"enum":["stacked","content_left","content_right","sidebar_left","sidebar_right"],"type":"string","title":"FlowLayoutEnum"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"denied_action"}
                        required={false}
                        schemaName={"DeniedActionEnum (string)"}
                        qualifierMessage={"**Possible values:** [`message_continue`, `message`, `continue`]"}
                        schema={{"enum":["message_continue","message","continue"],"type":"string","title":"DeniedActionEnum"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"authentication"}
                        required={false}
                        schemaName={"AuthenticationEnum (string)"}
                        qualifierMessage={"**Possible values:** [`none`, `require_authenticated`, `require_unauthenticated`, `require_superuser`, `require_outpost`]"}
                        schema={{"enum":["none","require_authenticated","require_unauthenticated","require_superuser","require_outpost"],"type":"string","title":"AuthenticationEnum"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"pk\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"policybindingmodel_ptr_id\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"name\": \"string\",\n  \"slug\": \"string\",\n  \"title\": \"string\",\n  \"designation\": \"authentication\",\n  \"background\": \"string\",\n  \"stages\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"policies\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n  ],\n  \"cache_count\": 0,\n  \"policy_engine_mode\": \"all\",\n  \"compatibility_mode\": true,\n  \"export_url\": \"string\",\n  \"layout\": \"stacked\",\n  \"denied_action\": \"message_continue\",\n  \"authentication\": \"none\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"400"}
        value={"400"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"non_field_errors"}
                        required={false}
                        schemaName={"string[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        name={"property name*"}
                        required={false}
                        schemaName={"any"}
                        qualifierMessage={undefined}
                        schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
                        collapsible={false}
                        discriminator={false}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"non_field_errors\": [\n    \"string\"\n  ],\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"403"}
        value={"403"}
      >
        <div>
          
          
          
          
          
        </div><div>
          <MimeTabs
            className={"openapi-tabs__mime"}
            schemaType={"response"}
          >
            <TabItem
              label={"application/json"}
              value={"application/json"}
            >
              <SchemaTabs
                className={"openapi-tabs__schema"}
              >
                <TabItem
                  label={"Schema"}
                  value={"Schema"}
                >
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary
                      style={{}}
                      className={"openapi-markdown__details-summary-response"}
                    >
                      <strong>
                        Schema
                      </strong>
                    </summary><div
                      style={{"textAlign":"left","marginLeft":"1rem"}}
                    >
                      
                    </div><ul
                      style={{"marginLeft":"1rem"}}
                    >
                      <SchemaItem
                        collapsible={false}
                        name={"detail"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"detail\": \"string\",\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>