---
title: "Update AutomationTemplate"
method: PATCH
path: "/api/v3/automation-template/{automation_template_id}"
tags: ["Automation Template"]
---

# Update AutomationTemplate

`PATCH /api/v3/automation-template/{automation_template_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/automation-template/{automation_template_id}`
- Auth: HTTP bearer

Update AutomationTemplate.

## Path parameters

- `automation_template_id` string, required

## Headers

- `EARLY-ACCESS` string

## Request body

- UpdateAutomationTemplateInput
  - `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`.
  - `description` string, nullable: Updated human-readable description. Must be at most 1500 characters. Set to `null` to clear the existing description; omit to leave it unchanged.
  - `name` string
  - `shouldPublish` boolean
  - `templateCollectionId` string

## Response `200`

OK

- AutomationTemplate: A reusable pipeline configuration that can be instantiated to create new Analysis objects. AutomationTemplates define a data processing workflow with AutomationSteps (see `steps`) that can be parameterized through config variables (see `AutomationTemplateVariable`) and data frame variables (see `AutomationTemplateDataFrameVariable`). When users apply a template to an Analysis, they provide values for these variables, generating a pipeline populated with actual data. Templates are organized within TemplateCollections and must be published before they can be applied.
  - `archiveReason` string, nullable
  - `archived` boolean
  - `configVariables` string, uri
  - `createdAt` string, datetime
  - `createdFromPipeline` AnalysisRef
    - `__typename` string
    - `id` string, api_id
  - `creator` PrincipalRef
    - `__typename` string
    - `id` string, api_id
  - `dataFrameVariables` string, uri
  - `id` string
  - `modifiedAt` string, datetime
  - `name` string
  - `steps` string, uri
  - `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)