Assigns a retention policy to an item in Box to enforce content retention. Use this action to apply a retention policy to: - An entire enterprise (assign_to_type='enterprise', no ID needed) - A specific folder (assign_to_type='folder', provide folder ID) - Items matching metadat…
policy_idRequiredstringThe unique ID of the retention policy to assign (e.g., '173463'). Get this from list_retention_policies or create_retention_policy.
filter_fieldsarrayOptional metadata filters when assign_to_type is 'metadata_template'. Array of objects with 'field' (metadata attribute key ID) and 'value' (field value ID). Only enum and multiselect field types are supported. Currently limited to one filter object.
assign__to__idstringThe ID of the target item. Required for 'folder' (folder ID like '6564564') and 'metadata_template' (template ID). Omit or set to null when assign_to_type is 'enterprise'.
assign__to__typeRequiredstringThe type of item to assign the policy to. Options: 'enterprise' (applies to all enterprise content), 'folder' (applies to specific folder by ID), 'metadata_template' (applies based on metadata criteria).
start_date_fieldstringThe date field that determines when retention begins. For 'metadata_template' assignments, this can be a date field's metadata attribute key ID (e.g., 'upload_date'). Only applicable when assign_to_type is 'metadata_template'.
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.