---
title: "Update a Compliance Orchestrator workflow's status"
method: PATCH
path: "/compliance/orchestrator/workflows/{workflowId}/status"
tags: ["Compliance Orchestrator (Beta)"]
---

# Update a Compliance Orchestrator workflow's status

`PATCH /compliance/orchestrator/workflows/{workflowId}/status`

## Request

- Base URL: `https://api.fireblocks.io/v1`
- URL: `https://api.fireblocks.io/v1/compliance/orchestrator/workflows/{workflowId}/status`
- Auth: none declared
- TypeScript: <https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/compliance/orchestrator/workflows/:workflowId/status/patch.ts> (a function with typed inputs; its response is checked against the schema)

Moves a workflow between `DRAFT` and `ACTIVE`. A workflow must be `ACTIVE` before `POST /v1/compliance/orchestrator/screenings` will accept a screening against it. Returns the workflow's id and new status, not its full configuration.

## Path parameters

- `workflowId` string, required

## Headers

- `Idempotency-Key` string

## Request body

- UpdateWorkflowStatusRequest: Request to change a workflow's status.
  - `status` 'ACTIVE' | 'DRAFT', required: A workflow's status, which controls whether it can be screened against. - `DRAFT` — the editing state. Rules can be changed while nothing is screening against them, so a screening never runs against a half-finished configuration. - `ACTIVE` — `POST /v1/compliance/orchestrator/screenings` accepts screenings against this workflow.

## Response `200`

Workflow status updated

- UpdateWorkflowStatusResponse: The workflow's status after the update.
  - `workflowId` string, required: Unique identifier of the workflow.
  - `status` 'ACTIVE' | 'DRAFT', required: A workflow's status, which controls whether it can be screened against. - `DRAFT` — the editing state. Rules can be changed while nothing is screening against them, so a screening never runs against a half-finished configuration. - `ACTIVE` — `POST /v1/compliance/orchestrator/screenings` accepts screenings against this workflow.

## Other responses

- `400`: Invalid request arguments.
- `404`: Workflow not found.
- `default`: Error Response

---

[API](https://skmtc.dev/fireblocks/apis/fireblocks-api.md) - [All operations](https://skmtc.dev/fireblocks/apis/fireblocks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fireblocks/apis/fireblocks-api/revisions/4eba9965659a?raw)