---
title: "Update PlateDesignTemplate"
method: PATCH
path: "/api/v3/plate-design-template/{plate_design_template_id}"
tags: ["Plate Design Template"]
---

# Update PlateDesignTemplate

`PATCH /api/v3/plate-design-template/{plate_design_template_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/plate-design-template/{plate_design_template_id}`
- Auth: HTTP bearer

Update PlateDesignTemplate.

## Path parameters

- `plate_design_template_id` string, required

## Request body

- UpdatePlateDesignTemplateInput
  - `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

## Response `200`

OK

- PlateDesignTemplate: A named plate design template backed by a plate record that lives in a template collection. Plate design templates allow plate records to be organized and reused as templates.
  - `archiveReason` string, nullable
  - `archived` boolean
  - `createdAt` string, datetime, nullable
  - `creator` PrincipalRef
    - `__typename` string
    - `id` string, api_id
  - `id` string
  - `modifiedAt` string, datetime, nullable
  - `name` string
  - `plateRecord` PlateRecordRef
    - `__typename` string
    - `id` string, api_id
  - `templateCollection` TemplateCollectionRef
    - `__typename` string
    - `id` string, api_id
  - `webUrl` string, nullable

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