Manage Applications

    Update legal hold policy

    put
    https://api.box.com/2.0
    /legal_hold_policies/:legal_hold_policy_id

    Update legal hold policy.

    Request

    application/json

    Path Parameters

    Request Body

    stringin bodyoptional
    A custom policy for the sales team500

    A description for the policy.

    stringin bodyoptional
    Sales Policy254

    The name of the policy.

    stringin bodyoptional
    Required for GDPR500

    Notes around why the policy was released.

    Response

    application/jsonLegal Hold Policy

    Returns a new legal hold policy object.

    application/jsonClient Error

    Returns an error if a policy with this name already exists.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -X PUT https://api.box.com/2.0/legal_hold_policies/324432 \
         -H "Authorization: Bearer <ACCESS_TOKEN>" \
         -H "Content-Type: application/json" \
         -d '{
           "policy_name": "Policy 4"
         }'
    .NET
    var updates = new BoxLegalHoldPolicyRequest()
    {
        Description = "Hold for documents related to the IRS audit"
    };
    BoxLegalHoldPolicy updatedPolicy = await client.LegalHoldPoliciesManager
        .UpdateLegalHoldPolicyAsync("11111", updates);
    Java
    BoxLegalHoldPolicy policy = new BoxLegalHoldPolicy(api, id);
    BoxLegalHoldPolicy.Info policyInfo = policy.new Info();
    info.addPendingChange("description", "new description");
    policy.updateInfo(info);
    Python
    policy_update = {'description': 'New Description', 'release_notes': 'Example Notes'}
    updated_policy = client.legal_hold_policy(policy_id='12345').update_info(policy_update)
    Node
    client.legalHoldPolicies.update('11111', {description: 'Documents related to IRS audit'})
    	.then(policy => {
    		/* policy -> {
    			type: 'legal_hold_policy',
    			id: '11111',
    			policy_name: 'IRS Audit',
    			description: 'Documents related to IRS audit',
    			status: 'active',
    			assignment_counts: { user: 1, folder: 0, file: 0, file_version: 0 },
    			created_by: 
    			{ type: 'user',
    				id: '22222',
    				name: 'Example User',
    				login: 'user@example.com' },
    			created_at: '2016-05-18T10:28:45-07:00',
    			modified_at: '2016-05-18T11:25:59-07:00',
    			deleted_at: null,
    			filter_started_at: '2016-05-17T01:00:00-07:00',
    			filter_ended_at: '2016-05-21T01:00:00-07:00' }
    		*/
    	});

    Response Example

    {
      "id": 11446498,
      "type": "legal_hold_policy",
      "policy_name": "Policy 4",
      "description": "Postman created policy",
      "status": "active",
      "assignment_counts": {
        "user": 1,
        "folder": 2,
        "file": 3,
        "file_version": 4
      },
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "deleted_at": "2012-12-12T10:53:43-08:00",
      "filter_started_at": "2012-12-12T10:53:43-08:00",
      "filter_ended_at": "2012-12-12T10:53:43-08:00",
      "release_notes": "Example"
    }