Skip to main content
PATCH
/
v1
/
legal_holds
/
{legal_hold_id}
Update a legal hold
curl --request PATCH \
  --url https://api.notion.com/admin/v1/legal_holds/{legal_hold_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Notion-Version: <notion-version>' \
  --data '
{
  "description": "<string>",
  "icon": "<string>",
  "name": "<string>"
}
'
{
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_time": 123,
  "id": "<string>",
  "start_date": 123,
  "user_interaction_type": [],
  "users": {
    "ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "total": 123
  },
  "workspaces": {
    "ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "total": 123
  },
  "description": "<string>",
  "end_date": 123,
  "icon": "<string>",
  "name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developers.notion.com/llms.txt

Use this file to discover all available pages before exploring further.

The organization bot token must have the following scopes:
  • legal-hold:write

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Notion-Version
enum<string>
required

The Admin API version to use for this request.

Available options:
2026-06-01

Path Parameters

​
legal_hold_id
string<uuid>
required

Body

application/json
​
description
string
​
icon
string
​
name
string

Response

​
created_by
string<uuid>
required
​
created_time
number
required
​
id
string
required
​
start_date
number
required
​
status
enum<string>
required
Available options:
active,
released
​
user_interaction_type
enum<string>[]
required
Available options:
page.created,
page.edited,
page.viewed
​
users
object
required
​
workspaces
object
required
​
description
string
​
end_date
number
​
icon
string
​
name
string