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
General → Edit Table Of Contents
AI-generatedSummary
Edit or append bookmarks (table of contents) in a PDF file by providing a JSON bookmark structure and specifying the PDF input either as binary data or a server-side file ID.
Inputs
- Input Binary Field Name (File Input) — Name of the binary property containing the PDF file data to modify.
- File Id — ID of a server-side PDF file to edit, used instead of binary input if the file was processed asynchronously before.
- Bookmark Data — Bookmarks structured in JSON format to set or append to the PDF's table of contents.
- Replace Existing — Boolean indicating whether to replace existing bookmarks (if true) or append to them (if false).
- Request Options — Advanced HTTP request options including batching, proxy, SSL validation override, and timeout settings.
Output shape
a single JSON object containing the updated PDF or confirmation details
Supports input of PDF data via binary or server file ID. Replacement vs append of bookmarks is controlled by the 'Replace Existing' parameter. Request options affect how API calls are performed but not the structure of the returned data.
Examples
Example 1: Edit PDF bookmarks using a binary file input, replacing existing bookmarks, with a specific JSON bookmark structure.
Set the binary property name to the file input, provide bookmarkData JSON, set replaceExisting to true.
Example 2: Append bookmarks to a previously uploaded PDF using its File ID.
Provide the fileId string, JSON bookmarkData, and set replaceExisting to false or leave default.