Only showGuidesEndpointsResourcesParams

Update retention policy

put

https://api.box.com/2.0

/retention_policies/:retention_policy_id

Updates a retention policy.

Request

Content-Typeapplication/json

Path Parameters

retention_policy_id stringin pathrequired

example982312

The ID of the retention policy.

Request Body

disposition_action stringin bodyoptional

examplepermanently_delete

The disposition action of the retention policy. This action can be permanently_delete, which will cause the content retained by the policy to be permanently deleted, or remove_retention, which will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy has expired.

Value is one of permanently_delete,remove_retention

policy_name stringin bodyoptional

exampleSome Policy Name

The name for the retention policy

status stringin bodyoptional

exampleretired

Value is always retired

Response

200application/jsonRetention policy

Returns the updated retention policy object.

400application/jsonClient error

Returns a bad_request if an incorrect disposition_action was set.

409application/jsonClient error

Returns an error if a retention policy with the given name already exists

defaultapplication/jsonClient error

An unexpected client error.

put

Update retention policy

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

Request Example

cURL .NET Java Python Node

cURL

curl -X PUT https://api.box.com/2.0/retention_policies/982312 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
     -H 'Content-Type: application/json" '
     -d '{
       "disposition_action": "permanently_delete"
     }'