---
title: "PUT /api/github/v1/work-manifests/{work_manifest_id}"
method: PUT
path: "/api/github/v1/work-manifests/{work_manifest_id}"
---

# PUT /api/github/v1/work-manifests/{work_manifest_id}

`PUT /api/github/v1/work-manifests/{work_manifest_id}`

## Path parameters

- `work_manifest_id` string, required

## Request body

- union
  - WorkManifestIndexResult
    - `paths` WorkManifestIndexPaths, required
    - `success` boolean, required
    - `symlinks` WorkManifestIndexSymlinks
    - `version` integer, required
  - WorkManifestBuildConfigResult
    - `config` unknown, required
  - WorkManifestBuildTreeResult
    - `files` object[], required
      - `changed` boolean
      - `id` string
      - `path` string, required
  - WorkManifestBuildResultFailure
    - `msg` string, required
  - WorkManifestTfOperationResult
    - `dirspaces` WorkManifestDirspaceResult[], required
      - `outputs` union[], required
        - union
          - WorkflowOutputApply
            - `outputs` OutputText
              - …
            - `success` boolean, required
            - `workflow_step` object, required
              - …
          - WorkflowOutputEnv
            - `outputs` OutputText
              - …
            - `success` boolean, required
            - `workflow_step` object, required
              - …
          - WorkflowOutputInit
            - `outputs` OutputText
              - …
            - `success` boolean, required
            - `workflow_step` object, required
              - …
          - WorkflowOutputOidc
            - `outputs` OutputText
              - …
            - `success` boolean, required
            - `workflow_step` object, required
              - …
          - WorkflowOutputPlan
            - `outputs` union
              - …
            - `success` boolean, required
            - `workflow_step` object, required
              - …
          - WorkflowOutputRun
            - `outputs` OutputText
              - …
            - `success` boolean, required
            - `workflow_step` object, required
              - …
      - `path` string, required
      - `success` boolean, required
      - `workspace` string, required
    - `overall` object, required
      - `outputs` HookOutputs, required
        - `post` union[], required
          - union
            - WorkflowOutputDriftCreateIssue
              - …
            - WorkflowOutputRun
              - …
            - WorkflowOutputEnv
              - …
            - WorkflowOutputOidc
              - …
        - `pre` union[], required
          - union
            - WorkflowOutputRun
              - …
            - WorkflowOutputEnv
              - …
            - WorkflowOutputCheckout
              - …
            - WorkflowOutputCostEstimation
              - …
            - WorkflowOutputOidc
              - …
      - `success` boolean, required
  - WorkManifestTfOperationResult2
    - `gates` Gate[]
      - `all_of` string[]
      - `any_of` string[]
      - `any_of_count` integer
      - `dir` string
      - `name` string
      - `token` string
      - `workspace` string
    - `steps` WorkflowStepOutput[], required
      - `ignore_errors` boolean, required
      - `payload` object, required
      - `scope` union, required
        - WorkflowStepOutputScopeDirspace
          - `dir` string, required
          - `type` string
          - `workspace` string, required
        - WorkflowStepOutputScopeRun
          - `flow` string, required
          - `subflow` string, required
          - `type` string
      - `step` string, required
      - `success` boolean, required

## Response `200`

## Other responses

- `403`

## Changes

- **2025-09-05** `a7b31838aecf` — 2 info
  - added the new optional request property `oneOf[#/components/schemas/work-manifest-tf-operation-result2]/gates/items/name`
  - the request property `oneOf[#/components/schemas/work-manifest-tf-operation-result2]/gates/items/token` became optional
- **2025-05-13** `049a16ba92ee` — 1 info
  - added the new optional request property `oneOf[#/components/schemas/work-manifest-build-tree-result]/files/items/id`
- **2025-04-11** `cd4e325d87d5` — 3 breaking, 1 info
  - added the new required request property `oneOf[#/components/schemas/work-manifest-build-config-result]/config`
  - removed `#/components/schemas/work-manifest-build-config-result-success, #/components/schemas/work-manifest-build-config-result-failure` from the `oneOf[#/components/schemas/work-manifest-build-config-result]/` request property `oneOf` list
  - the `oneOf[#/components/schemas/work-manifest-build-config-result]/` request property type/format changed from ``/`` to `object`/``
  - added `#/components/schemas/work-manifest-build-tree-result, #/components/schemas/work-manifest-build-result-failure` to the request body `oneOf` list
- **2025-03-30** `6ea2e0e14fda` — 1 info
  - added the new optional request property `oneOf[#/components/schemas/work-manifest-tf-operation-result2]/gates`
- **2024-10-10** `f31f0f3a6d3e` — 1 info
  - added `#/components/schemas/work-manifest-tf-operation-result2` to the request body `oneOf` list

[Full history](https://skmtc.dev/terrateamio/apis/untitled-api/changes/api/github/v1/work-manifests/:work_manifest_id/put.md)

---

[API](https://skmtc.dev/terrateamio/apis/untitled-api.md) · [All operations](https://skmtc.dev/terrateamio/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/terrateamio/untitled-api/revisions/1fd77fcac464/schema)