---
title: "Update flow metadata or status"
method: PATCH
path: "/flows/{id}"
tags: ["Flows"]
---

# Update flow metadata or status

`PATCH /flows/{id}`

## Request

- Base URL: `https://www.sociahive.com/api/v1`
- URL: `https://www.sociahive.com/api/v1/flows/{id}`
- Auth: one of:
  - API key in header `X-API-Key`
  - OAuth 2 (authorization code, authorization URL `/api/oauth/authorize`, token URL `/api/oauth/token`, scopes: `flows:write`)

## Path parameters

- `id` string, required: MongoDB ObjectId (24-character hex string)

## Request body

- object
  - `name` string
  - `description` string
  - `status` 'draft' | 'published' | 'archived'
  - `trigger` object

## Response `200`

Flow updated

- FlowUpdateEnvelope: PATCH /flows/{id} returns `{ success, flow }`; `warnings` (keyword conflicts) only when non-empty.
  - `success` boolean, required
  - `flow` object, required
  - `warnings` object[]

## Other responses

- `400`: Bad request — invalid parameters
- `401`: Authentication required — provide X-API-Key or Bearer token
- `403`: Insufficient scope for this operation
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/sociahive/apis/sociahive-api.md) · [All operations](https://skmtc.dev/sociahive/apis/sociahive-api/llms.txt) · [OpenAPI document](https://skmtc.dev/sociahive/apis/sociahive-api/revisions/791b8548d288?raw)