---
title: "Archive custom entities"
method: POST
path: "/custom-entities:archive"
tags: ["customEntities"]
---

# Archive custom entities

`POST /custom-entities:archive`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2`
- URL: `https://{tenant_name}.benchling.com/api/v2/custom-entities:archive`
- Auth: HTTP bearer

Archive custom entities

## Request body

- CustomEntitiesArchive: The request body for archiving custom entities.
  - `customEntityIds` string[], required
  - `reason` 'Made in error' | 'Retired' | 'Expended' | 'Shipped' | 'Contaminated' | 'Expired' | 'Missing' | 'Other', required: The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.

## Response `200`

OK

- CustomEntitiesArchivalChange: IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of custom entities along with any IDs of batches that were archived (or unarchived).
  - `batchIds` string[]
  - `customEntityIds` string[]

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)