Skip to main content

Delete Rows - Excel API

PDF4me Delete Rows enables you to remove rows from Excel documents with worksheet targeting and row range or condition support. This API service processes Excel files and deletes specified rows. The API receives Excel document content through REST API calls, utilizing Base64 encoding for secure transmission. This solution is ideal for data cleanup, template preparation, and automated Excel editing workflows.

Authenticating Your API Request

Include your API key in the request to authenticate with the PDF4me REST API.

Key Features

  • Row Deletion: Remove rows by index range or condition
  • Worksheet Targeting: Target specific worksheets by name or index

REST API Endpoint

  • Method: POST
  • Endpoint: office/ApiV2Excel/ExcelDeleteRows

REST API Parameters

Important: Parameters marked with an asterisk (*) are required. All requests use document, docContent, and deleteRowsToExcelAction. Operation-specific parameters (worksheetName, fromRow, toRow, etc.) are properties of the action object.

Required Parameters (root level)

ParameterTypeDescriptionExample
document*ObjectDocument reference with Name (Excel file name){ "Name": "data.xlsx" }
docContent*String (Base64)Excel document content encoded in Base64UEsDBBQABgAIAAAA...
deleteRowsToExcelAction*ObjectAction configuration (worksheet targeting, row range, etc.)See Payload example below

Optional Parameters (inside deleteRowsToExcelAction)

ParameterTypeDescriptionExample
worksheetNameStringTarget worksheet nameSheet1
worksheetIndexNumber (int)Target worksheet index (0-based)0
fromRowNumber (int)1-based start row index for deletion range5
toRowNumber (int)1-based end row index for deletion range10
cultureNameStringCulture code for processingen-US

Output

The API returns the Excel document as a Base64-encoded string in JSON format (document, fileName, success, errorMessage).

Request Example

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Payload (Basic)

{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"deleteRowsToExcelAction": {
"fromRow": 5,
"toRow": 10
}
}

Code Samples

Get Help