Legal Holds Create Policy

POST

https://api.dropboxapi.com/2/team/legal_holds/create_policy

POST

/2/team/legal_holds/create_policy

import requests
url = "https://api.dropboxapi.com/2/team/legal_holds/create_policy"
payload = {
    "members": ["dbmid:FDFSVF-DFSDF"],
    "name": "acme cfo policy",
    "end_date": "2017-12-31T00:00:00Z",
    "start_date": "2016-01-01T00:00:00Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

Response headers

HTTP/1.1 200 OK
X-Dropbox-Request-Id: string

{
  "id": "string",
  "members": {
    "permanently_deleted_users": 2,
    "team_member_ids": [
      "dbmid:efgh5678"
    ]
  },
  "name": "string",
  "start_date": "2024-01-15T09:30:00Z",
  "status": {
    ".tag": "active"
  },
  "activation_time": "2024-01-15T09:30:00Z",
  "description": "string",
  "end_date": "2024-01-15T09:30:00Z"
}

Creates new legal hold policy. Note: Legal Holds is a paid add-on. Not all teams have the feature.

Permission : Team member file access.

Required scope: team_data.governance.write

Endpoint format: RPC

Authentication: Team

Authentication

AuthorizationBearer

Team-level OAuth 2.0 token issued to a Dropbox Business admin. Use Authorization: Bearer <token>.

Obtain via the authorization code flow with team-scoped permissions.

Grants access to team-wide administrative operations.

You can generate a short-lived access token from the App Console; see Testing with a generated token.

Request

This endpoint expects an object.

memberslist of stringsRequired

List of team member IDs added to the hold.

namestringRequired<=140 characters

Policy name.

descriptionstring or nullOptional<=501 characters

A description of the legal hold policy.

end_datedatetime or nullOptional

end date of the legal hold policy.

start_datedatetime or nullOptional

start date of the legal hold policy.

Response headers

X-Dropbox-Request-IdstringOptional

A unique identifier for the request, useful for debugging and support.

Response

Successful response

idstringformat: "^pid_dbhid:.+"

The legal hold id.

membersobject

Team members IDs and number of permanently deleted members under hold.

namestring<=140 characters

Policy name.

start_datedatetime

Start date of the legal hold policy.

statusobject

The current state of the hold.

Variant:

team.LegalHoldStatus.activeobject

The legal hold policy is active.

activation_timedatetime or nullOptional

The time at which the legal hold was activated.

descriptionstring or nullOptional<=501 characters

A description of the legal hold policy.

end_datedatetime or nullOptional

End date of the legal hold policy.

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

429

Too Many Requests Error

500

Internal Server Error