Excel API icon

Excel API

Access Excel files via API with concurrent safety

Actions4

Delete

AI-generated

Summary

Delete rows from a specified Excel worksheet on the server where the value in a specified lookup column matches the provided lookup value, with an option to delete either all matching records or only the first match.

Inputs

  • File Name (required) — Select or enter the exact Excel file name from the server.
  • Sheet Name — Select or enter the worksheet name within the Excel file.
  • Lookup Column (required) — Specify the column name (from the first row headers) to search for the lookup value.
  • Lookup Value (required) — Provide the value to find in the lookup column to identify rows to delete; supports expressions.
  • Process Mode — Choose whether to delete all matching rows ('All Matching Records') or only the first found match ('First Match Only'). Defaults to all.

Output shape

a list of JSON objects, each representing the API response for each input item processed

If no rows match the lookup criteria, the operation throws an error indicating no matching rows were found. The API response typically includes a success flag and count of deleted rows.

Examples

Example 1: Delete all rows where the 'EmployeeID' column matches 'E001' in 'report.xlsx' on sheet 'Sheet1'

Set File Name to 'report.xlsx', Sheet Name to 'Sheet1', Lookup Column to 'EmployeeID', Lookup Value to 'E001', and Process Mode to 'All Matching Records'.

Links

Discussion