Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Legal Hold

Manage Legal Hold policy details - v4

Edit the details of a Legal Hold policy using policyID.

put/legalholds/v4/policies/{policyId}

Path parameters

policyIdinteger required

Unique ID of the Legal Hold policy. Example - 4

Request body

namestring

Name of the Legal Hold policy. Example - Jan_2021. Note: Changing the name of the legal Hold policy will have an impact on long-running eDiscovery Download jobs. Initiate a new eDiscovery Download job in case of failure.

legalHoldTypestring

Type of Legal Hold policy created. It can be custom or pre-defined. Example- Human Resources

startDatestring mmm DD YYYY

Displays the start time if the webdav access type option selected is 'Data within a Date Range'. Example- Apr 11 2021

endDatestring mmm DD YYYY

Displays the end time if the webdav access type option selected is 'Data within a Date Range'. Example- Jun 12 2021

webDavAccessType'All Collected Data' | 'Last Collected Data' | 'Data within a Date Range'

Details about the type of Webdav access. This field is case-sensitive. Example- 'All Collected Data' OR 'Last Collected Data' OR 'Data within a Date Range'

isADCEnabledtrue | false

Indicates if Additional Data Collection feature is enabled for Legal Hold policy. Example-true/false

accessAdditionalDatatrue | false

Indicates if Additional Data access option is enabled for Legal Hold policy. Example-true/false

accessBackupDatatrue | false

Indicates if backup data access option is enabled for Legal Hold policy. Example-true/false

collectionFrequency'One time' | 'Recurring'

Provides details about additional data collection frequency. This field is case-sensitive. Example - One time/Recurring

deletedFilesOnlytrue | false

Use 'true' to access only deleted files of users who belong to this Legal Hold policy. Else, use 'false'.

Example request

{
  "name": "Jan_2021",
  "legalHoldType": "Human Resources",
  "startDate": "Apr 11 2021",
  "endDate": "Jun 12 2021",
  "webDavAccessType": "Data within a Date Range",
  "collectionFrequency": "Recurring"
}

Response

messagestring
policyIdinteger

Example response

{
  "message": "Legal Hold updated successfully.",
  "policyId": 2
}