Skip to main content
PDF4me APIIntegrationsKnowledge BaseExtensionsAPI TesterBlog

Update Hyperlink Annotation - Link Manager API

PDF4me Update Hyperlink Annotation is a powerful enterprise-grade solution that updates and modifies hyperlink annotations in PDF documents through advanced API integration. This comprehensive hyperlink management service efficiently processes PDF files, providing reliable hyperlink updates, intelligent annotation modification, and advanced link management capabilities for enhanced document interactivity and workflow automation. The API processes hyperlink updates by receiving PDF documents through REST API calls, utilizing advanced annotation technology and intelligent link modification algorithms for accurate hyperlink updates and professional document annotation management. With comprehensive support for hyperlink updates, annotation modification, and professional link management, this solution is ideal for document interactivity, link management, automated updates, and enterprise document workflows that require reliable hyperlink modification with guaranteed accuracy and consistent output quality. Update hyperlink annotations easily with API for advanced document interactivity and link management.

Authenticating Your API Request​

To access the PDF4me REST API, every request must include proper authentication credentials. Authentication ensures secure communication and validates your identity as an authorized user of the REST API.

Get your api Key

Key Features​

  • Hyperlink Updates: Update and modify hyperlink annotations in PDF documents
  • Annotation Management: Intelligent hyperlink annotation modification and management
  • Link Modification: Comprehensive hyperlink URL and text updates
  • Professional Updates: High-quality hyperlink annotation updates and management
  • Flexible Processing: Support for various PDF formats and annotation types
  • Advanced Management: Detailed hyperlink analysis and intelligent update algorithms
  • Seamless API Integration: RESTful API designed for automated document processing workflows and enterprise system integration

REST API Endpoint​

The PDF4me REST API uses standard HTTP methods to interact with resources. All hyperlink annotation update operations are performed through a single endpoint:

  • Method: POST
  • Endpoint: /api/v2/UpdateHyperlinkAnnotation

The API provides comprehensive support for various hyperlink update and annotation modification capabilities:

  • URL Updates: Modify hyperlink URLs and destination addresses
  • Text Updates: Update hyperlink display text and annotations
  • Annotation Management: Comprehensive hyperlink annotation modification
  • Professional Updates: High-quality hyperlink updates and management
  • Advanced Processing: Support for complex hyperlink update requirements
  • Link Modification: Update existing hyperlinks and annotations
  • Annotation Control: Manage hyperlink annotations and properties
  • Professional Management: High-quality link management and updates
  • Flexible Options: Customizable update parameters for specific requirements

Update Technology​

  • Intelligent Analysis: Advanced hyperlink analysis and annotation assessment
  • Automated Updates: Intelligent hyperlink update and modification algorithms
  • Professional Technology: High-quality hyperlink management and updates
  • Advanced Processing: Support for various update scenarios

REST API Parameters​

Complete list of parameters for the Update Hyperlink Annotation REST API. Parameters are organized by category for better understanding and implementation.

Important: Parameters marked with an asterisk (*) are required and must be provided for the API to function correctly.

Required Parameters​

ParameterTypeDescriptionExample
docName*StringName of the file. The source PDF document filename with proper .pdf extension for hyperlink annotation update operations. This parameter identifies the input document for hyperlink processing, annotation modification, and update workflows. Required for document identification and processing pipeline management in hyperlink update operations.document.pdf
docContent*Base64The content of the input file. The complete content of the PDF document encoded in Base64 format for hyperlink annotation update and modification operations. This parameter contains the entire PDF file data required for hyperlink analysis, annotation updates, and modification workflows. Essential for secure document processing and API-based hyperlink update operations.JVBERi...
SearchOn*StringYou can take any value but it must be string. Example - Text. The search criteria for identifying hyperlinks to update. This parameter specifies the search method for locating hyperlinks within the PDF document. Used for hyperlink identification and targeting specific annotations for updates.Text
SearchValue*StringYou can take any value, but it must be string. Example - Example 1. The search value used to identify specific hyperlinks for updates. This parameter defines the search pattern for locating hyperlinks that need to be modified. Essential for precise hyperlink targeting and update operations.Example 1
IsExpression*BooleanYou can select any one value - true or false. Enable or disable expression-based search for hyperlink identification. This parameter controls whether the search uses regular expressions or exact matching. Default value is true.true
TextCurrentValue*StringYou can take any value but it must be string. Example - Example 1. The current display text of the hyperlink that needs to be updated. This parameter specifies the existing hyperlink text that will be replaced with the new value. Essential for identifying and updating specific hyperlink text.Example 1
TextNewValue*StringYou can take any value but it must be string. Example - Example 2. The new display text for the hyperlink after the update. This parameter defines the replacement text that will be applied to the hyperlink annotation. Required for hyperlink text modification and updates.Example 2
URLCurrentValue*StringExample - http://:www.google.com. The current URL destination of the hyperlink that needs to be updated. This parameter specifies the existing hyperlink URL that will be replaced with the new value. Essential for identifying and updating specific hyperlink destinations.http://:www.google.com
URLNewValue*StringExample - www.pdf4me.com. The new URL destination for the hyperlink after the update. This parameter defines the replacement URL that will be applied to the hyperlink annotation. Required for hyperlink destination modification and updates.www.pdf4me.com

Output​

The PDF4me Update Hyperlink Annotation REST API returns a response that can be viewed in multiple formats. Choose the view that best fits your needs:

JSON Response Format

The raw JSON response from the API:

{
  "File Content": "File content of the updated document"
}

Request Example​

Content-Type: application/json
Authorization:  YOUR_API_KEY

Note: Get your API key from the PDF4me Dashboard

Payload​

{
  "docName": "output.pdf",
  "docContent": "",
  "updatehyperlinkannotationlist": [
    {
      "SearchOn": "Text",
      "SearchValue": "Example 1",
      "IsExpression": true,
      "TextCurrentValue": "Example 1",
      "TextNewValue": "Example 2",
      "URLCurrentValue": "http://:www.google.com/",
      "URLNewValue": "www.pdf4me.com"
    },
    {
      "SearchOn": "Text",
      "SearchValue": "Example 2",
      "IsExpression": true,
      "TextCurrentValue": "Example 2",
      "TextNewValue": "Example 1",
      "URLCurrentValue": "www.pdf4me.com",
      "URLNewValue": "www.google.com"
    }
  ]
}

Code Samples​

The PDF4me Update Hyperlink Annotation REST API provides code samples in multiple programming languages. Choose the language that best fits your development environment:

C# (CSharp) Sample

Complete C# implementation for hyperlink annotation updates:

  • URL Updates: Modify hyperlink URLs and destination addresses
  • Text Updates: Update hyperlink display text and annotations
  • Annotation Management: Comprehensive hyperlink annotation modification
  • Professional Updates: High-quality hyperlink updates and management
  • Advanced Processing: Support for complex hyperlink update requirements
  • Link Modification: Update existing hyperlinks and annotations
  • Annotation Control: Manage hyperlink annotations and properties
  • Professional Management: High-quality link management and updates
  • Flexible Options: Customizable update parameters for specific requirements

Update Technology​

  • Intelligent Analysis: Advanced hyperlink analysis and annotation assessment
  • Automated Updates: Intelligent hyperlink update and modification algorithms
  • Professional Technology: High-quality hyperlink management and updates
  • Advanced Processing: Support for various update scenarios

Industry Use Cases & Applications​

Use Cases

  • Document Management: Update hyperlinks in PDF documents for better navigation
  • Link Maintenance: Maintain and update hyperlinks in enterprise documents
  • Workflow Automation: Integrate hyperlink updates into automated workflows
  • Document Interactivity: Enhance PDF document interactivity and user experience
  • Automated Updates: Integrate hyperlink updates into automated workflows
  • Enterprise Integration: Professional-grade hyperlink management solutions
  • Document Processing: Advanced hyperlink update and annotation management
  • Business Process Automation: Automate hyperlink update workflows for enterprise operations

Get Help​

Get Your API KeyAPI SamplesGetting Started