---
title: "Put a task under a legal hold, or lift it"
url: https://hexelstudio.com/docs/api/harness/retention/hold
---

# Put a task under a legal hold, or lift it

**PUT** `/harness/tasks/{id}/hold`

## Headers

- `Authorization: string`

  `Bearer <token>`. A Hexel Studio access token for your organization.

- `X-Workspace-Id: string`

  The workspace the request acts in (`ws_...`). It never grants access by itself.

- `X-Environment-Id: string`

  The environment the request acts in (`env_...`). It never grants access by itself.

## Body parameters

- `hold: boolean`

## Returns

`200` 

## Errors

- `default` 

## Example

```bash
curl --request PUT \
  --url 'https://api.hexelstudio.com/v1/harness/tasks/{id}/hold' \
  --header "Authorization: Bearer $ACCESS_TOKEN" \
  --header 'X-Workspace-Id: X_WORKSPACE_ID' \
  --header 'X-Environment-Id: X_ENVIRONMENT_ID' \
  --header 'Content-Type: application/json' \
  --data '{
  "hold": true
}'
```
