Insert Links into PDF

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Adds one or more clickable link annotations to a PDF, targeted either by explicit page coordinates or by matching text, and makes the modified PDF available for download.


Link Placement: For each entry in input_options.link_info, provide query when type is text to link text matching that query wherever it's found on the page, or provide rect when type is rect to link an explicit coordinate box instead.

Endpoint

OAuth Scope

ZohoWriter.pdfEditor.ALLCopied!

Request Example

cURL
cURL
Java
Python
Deluge
Copied!
curl --request POST \
  --url https://www.zohoapis.com/pdfeditor/api/v1/pdf/annotation/link/insert \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: multipart/form-data' \
  -F 'file=@file_path' \
  -F 'input_options={
  "link_info": [
    {
      "type": "rect",
      "value": "https://zylker.com/annual-report",
      "rect": {
        "top": "100px",
        "left": "100px",
        "width": "200px",
        "height": "50px"
      },
      "page_range": "1-3"
    },
    {
      "type": "text",
      "value": "https://zylker.com/annual-report",
      "query": "Annual Report Summary",
      "page_range": "1"
    }
  ]
}' \
  -F 'password=OpenSesame123'

Request Body

multipart/form-data
filebinary(Required)

The source PDF to add links to, uploaded directly or imported from a publicly accessible URL. The file must be no larger than 50 MB, contain no more than 400 pages, and have no page larger than 2,400 square inches. Its filename must not exceed 255 characters. Supported formats: pdf.

Example
quarterly-review.pdf
input_optionsJSON Object(Required)

Configures the links to add to the PDF.

Example
{
  "link_info": [
    {
      "type": "rect",
      "value": "https://zylker.com/annual-report",
      "rect": {
        "top": "100px",
        "left": "100px",
        "width": "200px",
        "height": "50px"
      },
      "page_range": "1-3"
    },
    {
      "type": "text",
      "value": "https://zylker.com/annual-report",
      "query": "Annual Report Summary",
      "page_range": "1"
    }
  ]
}
Show Sub-Attributes
passwordstring(Optional)

The password to unlock the source PDF, if it is password-protected.

Example
OpenSesame123
Maximum Length :255255Copied!

Body Parameters

Copied!
// Note: payload contains multiple type attributes

// type: file
file = quarterly-review.pdf

// type: object
input_options = {
  "link_info": [
    {
      "type": "rect",
      "value": "https://zylker.com/annual-report",
      "rect": {
        "top": "100px",
        "left": "100px",
        "width": "200px",
        "height": "50px"
      },
      "page_range": "1-3"
    },
    {
      "type": "text",
      "value": "https://zylker.com/annual-report",
      "query": "Annual Report Summary",
      "page_range": "1"
    }
  ]
}

// type: string
password = OpenSesame123
▼ Show full

Response Example

200
Copied!
  {
    "status": "inprogress",
    "status_check_url": "https://www.zohoapis.com/pdfeditor/api/v1/pdf/annotation/link/insert/job/3f65c7592a741d98e46bf310cbe678f574a1d51fce306a8d9b6430217e538acd"
  }
                
▼ Show full

Rate Limits

Duration1 minute
Threshold50
Lock Period5 minutes 30 seconds
Duration1 hour
Threshold200
Lock Period15 minutes
Duration1 day
Threshold2000
Lock Period2 hours

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.