---
title: "PUT /v1/flows/{numericFlowId}"
method: PUT
path: "/v1/flows/{numericFlowId}"
tags: ["flows"]
---

# PUT /v1/flows/{numericFlowId}

`PUT /v1/flows/{numericFlowId}`

## Request

- The document declares no server URL.
- Auth: HTTP bearer

Update a Flow's configuration and metadata

## Request body

- UpdateFlowDto
  - `name` string: The name of the Flow
  - `data` string: JSON or YAML encoded raw data of thew Flow. If provided in JSON format it will be converted to YAML automatically
  - `description` string: The description of the Flow
  - `targetingLogic` string: The targeting logic for the Flow
  - `type` 'ANNOUNCEMENT' | 'BANNER' | 'CARD' | 'CHECKLIST' | 'CUSTOM' | 'FORM' | 'SURVEY' | 'TOUR': The type of Flow
  - `active` boolean: Whether the Flow is active or not. If set to `false`, the Flow will not be shown to users

## Response `200`

The flow has been successfully updated.

- ExternalizedFlow
  - `id` number: The numeric ID of the Flow. This number will be different depending on the version used
  - `name` string: The name of the Flow
  - `data` string: JSON encoded raw data of the Flow as defined in the Flow's YAML configuration
  - `targetingLogic` string: The targeting logic for the Flow
  - `type` 'ANNOUNCEMENT' | 'BANNER' | 'CARD' | 'CHECKLIST' | 'CUSTOM' | 'FORM' | 'SURVEY' | 'TOUR': The type of Flow
  - `slug` string: A unique identifier for the Flow such as `flow_abc`. Slugs stay the same between environment and versions.
  - `createdAt` string, date-time: The data the Flow was created in ISO 8601 format
  - `modifiedAt` string, date-time: The data the Flow was last modified in ISO 8601 format
  - `version` number: The version of the Flow
  - `status` 'ACTIVE' | 'ARCHIVED' | 'DRAFT': The status of the Flow
  - `codeSnippet` string: The original code snippet for the Flow when it was created

---

[API](https://skmtc.dev/frigadehq/apis/frigade-api.md) - [All operations](https://skmtc.dev/frigadehq/apis/frigade-api/llms.txt) - [OpenAPI document](https://skmtc.dev/frigadehq/apis/frigade-api/revisions/92c033821b45?raw)