Creates a retention policy for managing content lifecycle in Box. Retention policies prevent permanent deletion of content for a specified duration. Once created, policies can be assigned to folders or the entire enterprise. Note: This endpoint requires the Box Governance add-on…
descriptionstringThe additional text description of the retention policy (max 500 characters).
policy_nameRequiredstringThe name for the retention policy. Must be unique within the enterprise.
policy_typeRequiredstringThe type of the retention policy. Use 'finite' when the retention duration is known upfront, or 'indefinite' when the retention duration is unknown. For finite policies, retention_length must be specified.
retention_typestringRetention type enum: controls if policy can be modified after creation.
retention_lengthintegerThe number of days to retain content under this policy. Required when policy_type is 'finite'. Minimum value is 1 day. For 'indefinite' policies, this field should not be set. Specify as an integer (e.g., 30, 365, 2555).
disposition_actionRequiredstringThe action to take when the retention policy expires. 'permanently_delete' will permanently delete the retained content. 'remove_retention' lifts the retention policy, allowing users to delete the content manually.
are_owners_notifiedbooleanWhether owners and co-owners of files are notified when the retention policy nears expiration.
can_owner_extend_retentionbooleanWhether file owners are allowed to extend the retention period before it expires.
custom_notification_recipientsarrayA list of users to notify when the retention policy duration is about to end. Each user should be specified with at least their 'id' field. Example: [{'type': 'user', 'id': '12345678'}]
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.