DRdruva
Legal Hold

Add users (custodians) to a legal hold policy - v4

Adds users to a Druva inSync legal hold policy. Up to 500 email addresses are processed per request; additional addresses are excluded, with the response message confirming the applied threshold.

post/legalholds/v4/policies/{policyId}/users

Request

  • Base URL
    https://apis.druva.com/insync
  • URL
    https://apis.druva.com/insync/legalholds/v4/policies/{policyId}/users
  • Auth
    API key in header Authorization

Path parameters

policyIdinteger required

Specify the unique identifier for the legal hold policy where the custodians should be added.

Request body

emailIDsstring[] required

Email addresses of custodians to add or remove. The list must not be empty. Only the first 500 addresses are processed.

Example request

{
  "emailIDs": [
    "ernie.carter@druva.com",
    "john.doe@druva.com"
  ]
}

Response

OK

usersAddedstring[]

Email addresses that were added to the legal hold policy.

usersNotAddedstring[]

If a user is already subject to a legal hold when being added to a legal hold policy, their email address will be included in this list.

notInSyncMailsstring[]

If a user is not a valid inSync user when being added to a legal hold policy, their email address will be returned in this list.

messagestring

Outcome summary. Contains details indicating if any users were previously placed on legal hold, along with a notification if the request exceeded the limit and was capped at 500 emails.

Example response

{
  "usersAdded": [
    "ernie.carter@druva.com"
  ],
  "usersNotAdded": [
    "john.doe@druva.com"
  ],
  "notInSyncMails": [
    "jane.smith@someorg.com"
  ],
  "message": "Custodian(s) added to legal hold successfully."
}

Changes

No recorded changes to this operation across all 1 revision of this API.