An alternative method to overwrite and update all Box Skill metadata cards on a file. IMPORTANT: This endpoint is designed for Box Skills applications. The skill_id parameter must be a valid Box-assigned skill invocation ID that is received in the webhook payload when Box trigge…
statusRequiredstringDefines the status of this skill invocation. Set to 'success' when applying completed skill cards. Use 'processing' to indicate ongoing processing, 'invoked' when the skill has been triggered, 'transient_failure' for recoverable errors, or 'permanent_failure' for unrecoverable e…
file__idstringThe ID of the file to assign the skill cards to. Required when specifying file. The file ID can be found in the Box URL: https://*.app.box.com/files/{file_id}
skill_idRequiredstringThe Box-assigned skill invocation ID. This ID is received in the webhook payload sent by Box when a skill is triggered on a file. It is NOT the same as the skill service ID or invocation ID you specify in skill cards. Example format: a numeric string like '33243242'.
file__typestringThe type of the item, always 'file'. Required when specifying file.
usage__unitstringThe unit of usage for the skill invocation, typically 'file'. This is usually omitted unless tracking skill usage metrics.
usage__valueintegerThe value of usage for the skill invocation, typically 1. This is usually omitted unless tracking skill usage metrics.
metadata__cardsarrayA list of Box Skill cards to apply to this file. These cards will overwrite any existing skill cards on the file. Each card must include: 'type' (always 'skill_card'), 'skill_card_type' (one of: 'keyword', 'transcript', 'timeline', 'status'), 'skill' (object with 'type': 'servic…
file__version__idstringThe ID of the specific file version to assign the cards to. Optional - if not provided, the cards are applied to the current file version.
file__version__typestringThe type of the file version, always 'file_version'. Only required when targeting a specific file version instead of the current version.
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.