---
title: "Batch update ResultSchema"
method: PATCH
path: "/api/v3/result-schema:batch-update"
tags: ["Result Schema"]
---

# Batch update ResultSchema

`PATCH /api/v3/result-schema:batch-update`

## Request

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

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

## Request body

- object
  - `items` UpdateResultSchemaInputWithPathParams[], 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`.
    - `id` string, required: The API ID of the schema to update. The schema must exist and be accessible.
    - `name` string: Updated user-facing name. When provided, must be non-empty after stripping whitespace, at most 255 characters, and unique within the organization.
    - `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.

## Response `200`

OK

- ResultSchemaBatchupdateResponse200
  - `items` ResultSchema[], required
    - `__typename` string
    - `archiveReason` string, nullable
    - `archived` boolean
    - `createdAt` string, datetime, nullable
    - `fieldDefinitions` string, uri: Defines the metadata fields for results belonging to this schema
    - `id` string
    - `modifiedAt` string, datetime, nullable: DateTime the Result Schema was last modified
    - `name` string
    - `organization` OrganizationRef
      - `__typename` string
      - `id` string, api_id
    - `systemName` string: The unique, machine-readable identifier for warehouse and API access.

## 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/c9f087b98b8b?raw)