---
title: "Update WorkflowTaskGroup"
method: PATCH
path: "/api/v3/workflow-task-group/{workflow_task_group_id}"
tags: ["Workflow Task Group"]
---

# Update WorkflowTaskGroup

`PATCH /api/v3/workflow-task-group/{workflow_task_group_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/workflow-task-group/{workflow_task_group_id}`
- Auth: HTTP bearer

Update WorkflowTaskGroup.

## Path parameters

- `workflow_task_group_id` string, required

## Request body

- UpdateWorkflowTaskGroupInput
  - `archiveReason` string: Why it is being archived. Required when `archived` is `true`, and not allowed when unarchiving.
  - `archived` boolean: Set to `true` to archive or `false` to unarchive it. Archiving requires `archiveReason`.
  - `name` string: The name of the workflow task group.

## Response `200`

OK

- WorkflowTaskGroup: A container that groups related `WorkflowTask` instances together, representing a cohesive unit of work. Task groups are created from a `WorkflowTaskSchema` (via `workflowTaskSchema`). They are stored in `Folder`s and can have `authors` and `watchers` for collaboration. In flowchart workflows, task groups can be nested: `childWorkflowTaskGroups` contains sub-groups for flowchart nodes, and `rootWorkflowTaskGroup` points to the parent when this group is part of a larger flowchart. When created from a `RequestV2Submission`, the `requestSubmission` field links back to the originating request. Task groups aggregate the outputs from all their tasks via `workflowOutputs`.
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `authors` string, uri, nullable
  - `childWorkflowTaskGroups` string, uri, nullable: The list of workflow task groups for which this task group is the root in a flowchart
  - `createdAt` string, datetime
  - `creator` PrincipalRef
    - `__typename` string
    - `id` string, api_id
  - `displayId` string, nullable: User-friendly ID of the workflow task group
  - `folder` FolderRef
    - `__typename` string
    - `id` string, api_id
  - `id` string: The ID of the workflow task group
  - `modifiedAt` string, datetime
  - `name` string, nullable: The name of the workflow task group
  - `requestSubmission` RequestV2SubmissionRef
    - `__typename` string
    - `id` string, api_id
  - `rootWorkflowTaskGroup` WorkflowTaskGroupRef
    - `__typename` string
    - `id` string, api_id
  - `workflowOutputs` string, uri, nullable: The outputs of the workflow task group
  - `workflowTaskSchema` WorkflowTaskSchemaRef
    - `__typename` string
    - `id` string, api_id
  - `workflowTasks` string, uri, nullable: The tasks in the workflow task group

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

---

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