B
BoxApi
Arcade Native

AbortUploadSession

BoxApi.AbortUploadSession

Arcade Native Built and maintained by Arcade with full support
Supported by Arcade

Description

Abort an upload session and discard all uploaded data.

Use this tool to abort an ongoing upload session and discard all uploaded data. This action is irreversible, so it should be called when the user wants to cancel an upload session.

Input Parameters

{
  "parameters": [
    {
      "name": "upload_session_id",
      "required": true,
      "inferrable": true,
      "description": "The unique identifier of the upload session to be aborted. This ID is required to specify which upload session should be cancelled and its data discarded.",
      "value_schema": {
        "val_type": "string"
      }
    }
  ]
}

Output

{
  "description": "Response from the API endpoint 'delete_files_upload_sessions_id'.",
  "value_schema": {
    "val_type": "json"
  },
  "available_modes": [
    "value",
    "error"
  ]
}