# Update Workflow Status

> PUT /api/v1/workflow/{workflow_id}/status — request parameters and responses from the Menace Voice API schema.

`PUT /api/v1/workflow/{workflow_id}/status`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| workflow_id | path | integer | yes |  |
| authorization | header | string or null | no |  |
| X-API-Key | header | string or null | no |  |

### Request body: application/json

Required body. Schema: UpdateWorkflowStatusRequest (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| status | string | yes |  |

### Response 200

Successful Response

application/json: WorkflowResponse (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| id | integer | yes |  |
| name | string | yes |  |
| status | string | yes |  |
| created_at | string | yes | format: "date-time" |
| workflow_definition | object | yes |  |
| current_definition_id | integer or null | yes |  |
| template_context_variables | object or null | no |  |
| call_disposition_codes | CallDispositionCodes (object) or null | no |  |
| total_runs | integer or null | no |  |
| workflow_configurations | object or null | no |  |
| version_number | integer or null | no |  |
| version_status | string or null | no |  |
| workflow_uuid | string or null | no |  |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json put /api/v1/workflow/{workflow_id}/status
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/workflow/{workflow_id}/status:
    put:
      tags:
        - main
      summary: Update Workflow Status
      description: |-
        Update the status of a workflow (e.g., archive/unarchive).

        Args:
            workflow_id: The ID of the workflow to update
            request: The status update request

        Returns:
            The updated workflow
      operationId: update_workflow_status_api_v1_workflow__workflow_id__status_put
      parameters:
        - name: workflow_id
          in: path
          required: true
          schema:
            type: integer
            title: Workflow Id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: Authorization
        - name: X-API-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Api-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateWorkflowStatusRequest"
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/WorkflowResponse"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    CallDispositionCodes:
      properties:
        disposition_codes:
          items:
            type: string
          type: array
          title: Disposition Codes
          default: []
      type: object
      title: CallDispositionCodes
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UpdateWorkflowStatusRequest:
      properties:
        status:
          type: string
          title: Status
      type: object
      required:
        - status
      title: UpdateWorkflowStatusRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    WorkflowResponse:
      properties:
        id:
          type: integer
          title: Id
        name:
          type: string
          title: Name
        status:
          type: string
          title: Status
        created_at:
          type: string
          format: date-time
          title: Created At
        workflow_definition:
          additionalProperties: true
          type: object
          title: Workflow Definition
        current_definition_id:
          anyOf:
            - type: integer
            - type: "null"
          title: Current Definition Id
        template_context_variables:
          anyOf:
            - additionalProperties: true
              type: object
            - type: "null"
          title: Template Context Variables
        call_disposition_codes:
          anyOf:
            - $ref: "#/components/schemas/CallDispositionCodes"
            - type: "null"
        total_runs:
          anyOf:
            - type: integer
            - type: "null"
          title: Total Runs
        workflow_configurations:
          anyOf:
            - additionalProperties: true
              type: object
            - type: "null"
          title: Workflow Configurations
        version_number:
          anyOf:
            - type: integer
            - type: "null"
          title: Version Number
        version_status:
          anyOf:
            - type: string
            - type: "null"
          title: Version Status
        workflow_uuid:
          anyOf:
            - type: string
            - type: "null"
          title: Workflow Uuid
      type: object
      required:
        - id
        - name
        - status
        - created_at
        - workflow_definition
        - current_definition_id
      title: WorkflowResponse
````