---
title: "Archive Custom Field"
method: DELETE
path: "/api/v1/hris/custom-fields/{customFieldId}"
tags: ["Custom Fields", "Public API"]
---

# Archive Custom Field

`DELETE /api/v1/hris/custom-fields/{customFieldId}`

## Request

- Base URL: `https://companySubDomain.bamboohr.com`
- URL: `https://companySubDomain.bamboohr.com/api/v1/hris/custom-fields/{customFieldId}`
- Auth: OAuth 2
  - Authorization code: `/authorize.php`
  - Token URL: `/token.php` scopes: `employee:custom_fields.write`
- TypeScript: <https://skmtc.dev/bamboohr/apis/bamboohr-api/docs/api/v1/hris/custom-fields/:customFieldId/delete.ts> (a function with typed inputs; its response is checked against the schema)

Archive a custom field.

OAuth Scopes: employee:custom_fields.write

## Path parameters

- `customFieldId` string, required

## Response `200`

Custom field archived.

- object
  - `success` boolean

## Other responses

- `400`: Invalid argument.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Not found.
- `409`: Conflict.
- `422`: Validation failed.
- `500`: Internal server error.

## Changes

- **2026-11-03** `922fc15f43a7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bamboohr/apis/bamboohr-api/changes/api/v1/hris/custom-fields/:customFieldId/delete.md)

---

[API](https://skmtc.dev/bamboohr/apis/bamboohr-api.md) - [All operations](https://skmtc.dev/bamboohr/apis/bamboohr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bamboohr/apis/bamboohr-api/revisions/922fc15f43a7?raw)