Box Assign Retention Policy

• policy_idstring

  Required
  The unique ID of the retention policy to assign (e.g., '173463'). Get this from list_retention_policies or create_retention_policy.
• filter_fieldsarray
  Optional 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__idstring
  The 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__typestring

  Required
  The 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_fieldstring
  The 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'.

• data

  Required
  Data from the action execution
• errorstring
  Error if any occurred during the execution of the action
• successfulboolean

  Required
  Whether or not the action execution was successful or not

No verified related use cases are linked yet.

No published Skills explicitly reference this Action yet.