Create retention policy

POST https://{{api.box.com}}/2.0/retention_policies

Creates a retention policy.

https://developer.box.com/reference/post-retention-policies

Request Body

{"policy_name"=>"Some Policy Name", "description"=>"Policy to retain all reports for at least one month", "policy_type"=>"finite", "disposition_action"=>"permanently_delete", "retention_length"=>"365", "retention_type"=>"modifiable", "can_owner_extend_retention"=>true, "are_owners_notified"=>true, "custom_notification_recipients"=>[{"id"=>"11446498", "type"=>"user", "name"=>"Aaron Levie", "login"=>"ceo@example.com"}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: Created

{"id":"12345","type":"retention_policy","policy_name":"Some Policy Name","retention_length":"365","disposition_action":"permanently_delete","description":"Policy to retain all reports for at least one month","policy_type":"finite","retention_type":"non_modifiable","status":"active","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","can_owner_extend_retention":false,"are_owners_notified":false,"custom_notification_recipients":[{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"}],"assignment_counts":{"enterprise":1,"folder":1,"metadata_template":1}}