Skip to content
AcrivaDocs

CreateLegalHold

POST
/api/v1/t/{tenant}/compliance/legal-holds
curl --request POST \
  --url https://example.com/api/v1/t/example/compliance/legal-holds \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "reason": "example", "documentIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "fileIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
reason
required
string
documentIds
required
Array<string> | null
fileIds
required
Array<string> | null
Examplegenerated
{
  "name": "example",
  "reason": "example",
  "documentIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "fileIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ]
}

Responses

Section titled “ Responses ”

201

Section titled “201”

Created

Media typeapplication/json
object
hold
required
object
id
required
string format: uuid
name
required
string
reason
required
string
createdBy
required
string format: uuid
createdAt
required
string format: date-time
liftedBy
required
null | string format: uuid
liftedAt
required
null | string format: date-time
liftReason
required
null | string
documentCount
required
integer format: int32
fileCount
required
integer format: int32
version
required
integer format: uint32
filling
boolean
notCovered
required
Array<string>
notCoveredHiddenCount
required
integer format: int32
Example
{
  "hold": {
    "filling": false
  }
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}