Dropbox: Creates new legal hold policy

Dropbox team.legalHoldsCreatePolicy: arguments, response, policy and SDK examples.

Operation dropbox.team_legal_holds_create_policy

Provider route: POST /2/team/legal_holds/create_policy. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/dropbox with npm, or alter-sdk-dropbox with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DropboxIntegration } from "@alter-ai/dropbox";

async function execute(input: Parameters<DropboxIntegration["team"]["legalHoldsCreatePolicy"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new DropboxIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.team.legalHoldsCreatePolicy(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_dropbox import DropboxIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = DropboxIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.team.legal_holds_create_policy(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`headers`	object	Optional	Additional keys: not allowed
`headers.Dropbox-API-Path-Root`	Model	Optional	Expand Deletes a group — request body — headers Dropbox-API-Path-Root
`headers.Dropbox-API-Select-User`	string	Optional
`headers.Dropbox-API-Select-Admin`	string	Optional
`body`	Model	Required within parent	Expand Creates new legal hold policy — request body — body

Referenced models: Deletes a group — request body — headers Dropbox-API-Path-Root, Creates new legal hold policy — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Updates a legal hold — response body

Referenced models: Updates a legal hold — response body

Schemas

Deletes a group — request body — headers Dropbox-API-Path-Root

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	string	Alternative	One of: home
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: home
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: root
`$ (anyOf 3).root`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: namespace_id
`$ (anyOf 4).namespace_id`	string	Required within parent	Pattern: ^(?:[-_0-9a-zA-Z:]+)$
`$ (anyOf 5)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 5)..tag`	string	Required within parent	Pattern: ^(?!(?:home\|root\|namespace_id)$)

Updates a legal hold — response body

Field	Type	Presence	Description and constraints
`$`	object	Root
`id`	string	Required within parent	Pattern: ^(?:^pid_dbhid:.+)$
`name`	string	Required within parent	Maximum length: 140
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	Maximum length: 501
`description (anyOf 2)`	null	Alternative
`activation_time`	JSON	Optional
`activation_time (anyOf 1)`	string	Alternative
`activation_time (anyOf 2)`	null	Alternative
`members`	Model	Required within parent	Expand Updates a legal hold — response body — members
`status`	Model	Required within parent	Expand Updates a legal hold — response body — status
`start_date`	string	Required within parent
`end_date`	JSON	Optional
`end_date (anyOf 1)`	string	Alternative
`end_date (anyOf 2)`	null	Alternative

Referenced models: Updates a legal hold — response body — status, Updates a legal hold — response body — members

Creates new legal hold policy — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root
`name`	string	Required within parent	Maximum length: 140
`description`	JSON	Optional
`description (anyOf 1)`	string	Alternative	Maximum length: 501
`description (anyOf 2)`	null	Alternative
`members`	array	Required within parent
`members[]`	string	Each item
`start_date`	JSON	Optional
`start_date (anyOf 1)`	string	Alternative
`start_date (anyOf 2)`	null	Alternative
`end_date`	JSON	Optional
`end_date (anyOf 1)`	string	Alternative
`end_date (anyOf 2)`	null	Alternative

Updates a legal hold — response body — status

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	string	Alternative	Known values: active, released, activating, updating, exporting, releasing
`$ (anyOf 2)`	object	Alternative
`$ (anyOf 2)..tag`	string	Required within parent	Must equal: active
`$ (anyOf 3)`	object	Alternative
`$ (anyOf 3)..tag`	string	Required within parent	Must equal: released
`$ (anyOf 4)`	object	Alternative
`$ (anyOf 4)..tag`	string	Required within parent	Must equal: activating
`$ (anyOf 5)`	object	Alternative
`$ (anyOf 5)..tag`	string	Required within parent	Must equal: updating
`$ (anyOf 6)`	object	Alternative
`$ (anyOf 6)..tag`	string	Required within parent	Must equal: exporting
`$ (anyOf 7)`	object	Alternative
`$ (anyOf 7)..tag`	string	Required within parent	Must equal: releasing
`$ (anyOf 8)`	object	Alternative	A tag this contract version does not list (Dropbox's other).
`$ (anyOf 8)..tag`	string	Required within parent	Pattern: ^(?!(?:active\|released\|activating\|updating\|exporting\|releasing)$)

Updates a legal hold — response body — members

Field	Type	Presence	Description and constraints
`$`	object	Root
`team_member_ids`	array	Required within parent
`team_member_ids[]`	string	Each item
`permanently_deleted_users`	JSON	Required within parent
`permanently_deleted_users (anyOf 1)`	integer	Alternative	Minimum: 0
`permanently_deleted_users (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: dropbox.team_legal_holds_create_policy. Catalog operation: team/legal_holds_create_policy. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["team_data.governance.write"]

Official provider source

Report an issue with this page