---
title: "Update Analysis"
method: PATCH
path: "/api/v3/analysis/{analysis_id}"
tags: ["Analysis"]
---

# Update Analysis

`PATCH /api/v3/analysis/{analysis_id}`

## Request

- Base URL: `https://{tenant_name}.benchling.com`
- URL: `https://{tenant_name}.benchling.com/api/v3/analysis/{analysis_id}`
- Auth: HTTP bearer

Update Analysis.

## Path parameters

- `analysis_id` string, required

## Headers

- `EARLY-ACCESS` string

## Request body

- UpdateAnalysisInput
  - `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
  - `folderId` string
  - `name` string
  - `studyIds` string[]: Study IDS to associate with the item.

## Response `200`

OK

- Analysis: Represents a data processing pipeline. Each Analysis contains a graph of AutomationSteps that works with data. An automation template (see `AutomationTemplate`) may be applied onto an analysis to provide a pre-configured graph of steps.
  - `__typename` string
  - `archiveReason` string, nullable
  - `archived` boolean
  - `createdAt` string, datetime
  - `creator` PrincipalRef
    - `__typename` string
    - `id` string, api_id
  - `description` string, nullable
  - `folder` FolderRef
    - `__typename` string
    - `id` string, api_id
  - `id` string
  - `modifiedAt` string, datetime
  - `name` string
  - `statusCode` 'AI_PROPOSED' | 'BLOCKED' | 'FAILED' | 'HALTED' | 'RUNNING' | 'SUCCEEDED' | 'SUCCEEDED_WITH_ERRORS' | 'WAITING'
  - `steps` string, uri
  - `webUrl` string

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