Remove Header Footer - Excel API
PDF4me Remove Header Footer enables you to remove headers and footers from Excel documents with optional worksheet targeting. This API service processes Excel files and clears text and image headers/footers. The API receives Excel document content through REST API calls, utilizing Base64 encoding for secure transmission. This solution is ideal for document cleanup, template reuse, 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
- Header/Footer Removal: Clear text and image headers and footers
- Worksheet Targeting: Apply to specific worksheets or all worksheets
REST API Endpoint
- Method: POST
- Endpoint:
office/ApiV2Excel/ExcelRemoveHeaderFooter
REST API Parameters
Important: Parameters marked with an asterisk (*) are required. All requests use document, docContent, and removeHeaderFooterToExcelAction. Operation-specific parameters (worksheetNames, worksheetIndexes, etc.) are properties of the action object.
Required Parameters (root level)
| Parameter | Type | Description | Example |
|---|---|---|---|
| document* | Object | Document reference with Name (Excel file name) | { "Name": "data.xlsx" } |
| docContent* | String (Base64) | Excel document content encoded in Base64 | UEsDBBQABgAIAAAA... |
| removeHeaderFooterToExcelAction* | Object | Action configuration (optional: worksheet targeting) | See Payload example below |
Optional Parameters (inside removeHeaderFooterToExcelAction)
| Parameter | Type | Description | Example |
|---|---|---|---|
| worksheetNames | Array (string[]) | Worksheet names to remove header/footer from; empty = all | ["Sheet1", "Report"] |
| worksheetIndexes | Array (int[]) | Worksheet indexes (0-based or 1-based per API spec); empty = all | [0, 2] |
| cultureName | String | Culture code for processing | en-US |
Output
The API returns the Excel document as a Base64-encoded string in JSON format (document, fileName, success, errorMessage).
Request Example
Header
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Payload (Basic)
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"removeHeaderFooterToExcelAction": {}
}
Payload (With worksheet targeting)
{
"document": { "Name": "data.xlsx" },
"docContent": "UEsDBBQABgAIAAAA...",
"removeHeaderFooterToExcelAction": {
"worksheetNames": ["Sheet1", "Report"],
"cultureName": "en-US"
}
}