Skip to main content
POST
Create legal hold

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

A name for the matter this hold preserves

Required string length: 1 - 200
Example:

"X v. Y"

covers_entire_workspace
boolean
required

Whether the hold covers every member of your workspace, current and future. Required: scope is never something a caller falls into.

Example:

false

description
string | null

Free text describing the matter

Maximum string length: 2000
Example:

"Preservation notice 2026-08-12"

custodians
object[]

Users to name individually when the hold is created

Maximum array length: 100

Response

The legal hold that was created

id
string
required

The unique identifier for the legal hold

Pattern: ^lgh_[a-zA-Z0-9]{14}$
Example:

"lgh_Abc123XyZ456De"

object
enum<string>
required

The type of object

Available options:
legal_hold
Example:

"legal_hold"

name
string
required

The name of the hold, as your admins see it

Example:

"X v. Y"

description
string | null
required

Free text describing the matter, or null

Example:

"Preservation notice 2026-08-12"

covers_entire_workspace
boolean
required

True when the hold covers every member of your workspace, current and future. Additive with custodian_count — a hold may do both.

Example:

false

custodian_count
integer
required

How many users this hold names individually. Workspace-wide coverage is covers_entire_workspace, not a custodian.

Example:

3

created_at
string<date-time>
required

When the hold was placed

Example:

"2026-09-21T10:00:00Z"

released_at
string<date-time> | null
required

When the hold was released, or null while it is active. A released hold is never deleted.

Example:

null