---
title: "Batch update WorkflowTaskSchema"
method: PATCH
path: "/api/v3/workflow-task-schema:batch-update"
tags: ["Workflow Task Schema"]
---

# Batch update WorkflowTaskSchema

`PATCH /api/v3/workflow-task-schema:batch-update`

## Request

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

Batch update WorkflowTaskSchema synchronously in one transaction. Maximum 25 items per request.

## Headers

- `EARLY-ACCESS` string

## Request body

- object
  - `items` UpdateWorkflowTaskSchemaInputWithPathParams[], required
    - `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`.
    - `canOnlyBePartOfFlowchart` boolean: Whether tasks of this schema can only exist as part of a flowchart.
    - `canSetAssigneeOnTaskCreation` boolean: Whether tasks of this schema can be created with a non-null assignee.
    - `defaultCreationFolderId` string, nullable: API ID of the default folder for creating workflow task groups.
    - `defaultEntryExecutionFolderId` string, nullable: API ID of the default folder for workflow task execution entries.
    - `defaultResponsiblePartyIds` string[]: API IDs of the default responsible parties for tasks of this schema.
    - `displayName` string: Deprecated. Use name instead.
    - `id` string, required: The API ID of the schema to update. The schema must exist and be accessible.
    - `isPropagateWatchersEnabled` boolean: Whether watchers are propagated for tasks of this schema.
    - `name` string: Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.
    - `prefix` string: The prefix for the displayId of tasks of this schema.
    - `systemName` string: Updated SQL identifier for the warehouse table name. When provided, must match the pattern [a-z_][a-z0-9_$]*, cannot be a reserved table name, cannot start with 'bnch$', and must be unique within the organization. Changing it requires warehouse table-name changes to be enabled for the caller; otherwise the update fails with a validation error. Supplying the schema's exact current system name always succeeds.
    - `taskGroupInstructions` string, nullable: The instructions for task groups of this schema.
    - `taskGroupPrefix` string: The prefix for the displayId of task groups containing tasks of this schema.
    - `workflowOutputSchema` UpdateWorkflowOutputSchemaInput
      - `prefix` string: The prefix for the displayId of workflow outputs of this schema.

## Response `200`

OK

- WorkflowTaskSchemaBatchupdateResponse200
  - `items` WorkflowTaskSchema[], required
    - `__typename` string
    - `archiveReason` string, nullable
    - `archived` boolean
    - `canOnlyBePartOfFlowchart` boolean
    - `canSetAssigneeOnTaskCreation` boolean: Whether or not tasks of this schema can be created with a non-null assignee.
    - `createdAt` string, datetime
    - `defaultCreationFolder` FolderRef
      - `__typename` string
      - `id` string, api_id
    - `defaultEntryExecutionFolder` FolderRef
      - `__typename` string
      - `id` string, api_id
    - `entryTemplate` EntryTemplateRef
      - `__typename` string
      - `id` string, api_id
    - `executionType` 'DIRECT' | 'ENTRY' | 'FLOWCHART' | 'PROCEDURE' | 'PROCEDURE_METHOD' | 'PROCEDURE_STEP' | 'PIPELINE': The method by which instances of this schema are executed
    - `fieldDefinitions` string, uri
    - `id` string
    - `isPropagateWatchersEnabled` boolean
    - `modifiedAt` string, datetime
    - `name` string
    - `organization` OrganizationRef
      - `__typename` string
      - `id` string, api_id
    - `prefix` string: The prefix for the displayId of tasks of this schema.
    - `systemName` string: A unique, stable identifier for this schema used for programmatic access and integrations.
    - `taskGroupInstructions` string, nullable: The instructions for task groups of this schema
    - `taskGroupPrefix` string: The prefix for the displayId of task groups containing tasks of this schema
    - `validationRules` string, uri
    - `workflowOutputSchema` WorkflowOutputSchemaRef
      - `__typename` string
      - `id` string, api_id

## 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)