Excel AI icon

Excel AI

Perform CRUD operations on Excel files with AI Agent support

Row → Clear Rows

AI-generated

Summary

Removes all data rows from a worksheet while optionally preserving the header row.

Inputs

  • inputMode — How to provide the Excel file: 'File Path' uses a system path, 'Binary Data' uses a binary property.
  • filePath — Absolute path to the Excel file (required when inputMode is 'File Path').
  • binaryPropertyName — Name of the binary property containing the Excel file (required when inputMode is 'Binary Data').
  • sheetName — Name of the worksheet to operate on. Defaults to the first sheet.
  • keepHeader — Whether to preserve the first row (header) when clearing rows.

Output shape

a single success object containing metadata

If the sheet has fewer rows than the clearing operation would affect, the operation returns a success object with clearedRows set to 0.

Examples

Example 1: Clear all data rows in a file located at /data/leads.xlsx while keeping the header row.

Input Mode: File Path; File Path: /data/leads.xlsx; Keep Header: true

Links

Discussion