API V2

Update Hyperlinks Annotation

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

Parameters

docNamestring, Required

Nae of the file.

docContentbase64, Required

The content of the input file

Update Hyperlinks Annotation List
SearchOnstring, Required

You can take any value but it must be string.
Example - Text

SearchValuestring, Required

You can take any value, but it must be string.
Example - Example 1

IsExpressionboolean, Required
Default: true

You can select any one value -

  • true
  • false
TextCurrentValuestring, Required

You can take any value but it must be string.
Example - Example 1

TextNewValuestring, Required

You can take any value but it must be string.
Example - Example 2

URLCurrentValuestring, Required

Example - http://:www.google.com

URLNewValuestring, Required

Example - www.pdf4me.com

SearchOnstring, Required

You can take any value but it must be string.
Example - Text

SearchValuestring, Required

You can take any value, but it must be string.
Example - Example 2

IsExpressionboolean, Required
Default: true

You can select any one value -

  • true
  • false
TextCurrentValuestring, Required

You can take any value but it must be string.
Example - Example 2

TextNewValuestring, Required

You can take any value but it must be string.
Example - Example 1

URLCurrentValuestring, Required

Example - www.pdf4me.com

URLNewValuestring, Required

Example - http://:www.google.com

Output

File ContentBinary

Header
Content-Type:application/json
Authorization: Please copy key from the link.

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"
    }
  ]
}

PDF4me api samples

CSharp(C#)
Java
JavaScript
Python
Salesforce
n8n
Google Script
AWS Lambda