Actions260
- Admin Job Management Actions
- Admin License Management Actions
- Admin Server Certificate Actions
- Admin Settings Actions
- AI Tools Actions
- Analysis Actions
- Audit Actions
- Authentication Actions
- Convert Actions
- Convert Ghostscript Inputs To Pdf
- Url To Pdf
- Convert Json To Pdf
- Convert Svg To Pdf
- Process Pdf To XML
- Pdf To Excel
- Process Pdf To Word
- Convert Pdf To Vector
- Process Pdf To RT For TXT
- Convert Pdf To Json
- Export Partial Pdf
- Extract Pdf Metadata
- Clear Cache
- Process Pdf To Presentation
- Pdf To Pdf A
- Process Pdf To Markdown
- Convert To Image
- Process Pdf To HTML
- Convert Pdf To Epub
- Pdf To Csv
- Convert Pdf To Cbz
- Convert Pdf To Cbr
- Markdown To Pdf
- Convert To Pdf
- Html To Pdf
- Process File To PDF
- Convert Eml To Pdf
- Convert Ebook To Pdf
- Convert Cbz To Pdf
- Convert Cbr To Pdf
- Extract Single Page
- Extract Page Fonts
- Database Actions
- File Storage Actions
- Filter Actions
- Forms Actions
- General Actions
- Info Actions
- Invite Actions
- Job Management Actions
- Misc Actions
- Metadata
- Unlock PDF Forms
- Extract Header
- Scanner Effect
- Replace And Invert Color
- Repair Pdf
- Rename Attachment
- Remove Blank Pages
- Process Pdf With OCR
- List Attachments
- Flatten
- Extract Images
- Extract Image Scans
- Extract Attachments
- Delete Attachment
- Decompress Pdf
- Optimize Pdf
- Auto Split Pdf
- Extract Header 1
- Add Stamp
- Add Page Numbers
- Overlay Image
- Add Comments
- Add Attachments
- Pipeline Actions
- Proprietary UI Data Actions
- Saved Signatures Actions
- Security Actions
- Signature Assets Actions
- Signing Sessions Actions
- Team Actions
- UI Data Actions
- User Actions
- Workflow Participant Actions
Security → Redact Pdf Manual
AI-generatedSummary
Redact specified areas on selected pages of a PDF file provided either by binary input or a file ID, with options to convert the result to an image and set the redaction color.
Inputs
- Input Binary Field Name (File Input) — Name of the binary property containing the PDF file data to redact (defaults to 'data').
- File Id — ID of a previously uploaded server-side PDF file to use instead of binary input for redaction.
- Page Numbers (required) — Pages to redact, supporting ranges (e.g., '1,3,5-9'), 'all', or functions like '2n+1'.
- Redactions (required) — List of areas on the pages to redact.
- Convert P D F To Image (required) — Boolean flag to convert the redacted PDF output to an image format.
- Page Redaction Color (required) — Hex color code used to fill fully redacted pages.
Output shape
a binary file containing the redacted PDF, or an image if conversion is enabled
The output file will reflect the redactions applied according to the input parameters; conversion to image is controlled via the 'Convert P D F To Image' option.
Examples
Example 1: Redact sensitive areas on pages 1 through 3 of an uploaded PDF binary input, output as a PDF with black redaction color.
Set 'Input Binary Field Name' to the binary property holding PDF data, 'Page Numbers' to '1-3', provide 'Redactions' as JSON, 'Convert P D F To Image' to false, and 'Page Redaction Color' to '#000000'.