Update PDF Metadata

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

Updates the document information metadata of a PDF, and makes the modified PDF available for download.

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/metadata/update \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: multipart/form-data' \
  -F 'file=@file_path' \
  -F 'input_options={
  "title": "Quarterly Review",
  "author": "Jane Smith",
  "subject": "Q3 Financial Summary",
  "keywords": "finance, quarterly, review",
  "creator": "Zoho Writer",
  "producer": "Zoho PDF Editor",
  "creation_date": "2024-01-15T10:30:00Z",
  "modification_date": "2024-01-20T14:45:00Z",
  "trapped": "False"
}' \
  -F 'password=OpenSesame123'

Request Body

multipart/form-data
filebinary(Required)

The source PDF to update, 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)

The metadata fields to update. Only the fields provided are changed; the rest of the PDF's metadata is left untouched. At least one field must be provided.

Example
{
  "title": "Quarterly Review",
  "author": "Jane Smith",
  "subject": "Q3 Financial Summary",
  "keywords": "finance, quarterly, review",
  "creator": "Zoho Writer",
  "producer": "Zoho PDF Editor",
  "creation_date": "2024-01-15T10:30:00Z",
  "modification_date": "2024-01-20T14:45:00Z",
  "trapped": "False"
}
Show Sub-Attributes
titlestring(Optional)

The document title.

Example
Quarterly Review
Maximum Length :255255Copied!
authorstring(Optional)

The document author.

Example
Jane Smith
Maximum Length :255255Copied!
subjectstring(Optional)

The document subject.

Example
Q3 Financial Summary
Maximum Length :255255Copied!
keywordsstring(Optional)

The document keywords.

Example
finance, quarterly, review
Maximum Length :10001000Copied!
creatorstring(Optional)

The name of the application that created the document.

Example
Zoho Writer
Maximum Length :255255Copied!
producerstring(Optional)

The name of the application that produced the PDF.

Example
Zoho PDF Editor
Maximum Length :255255Copied!
creation_datestring(Optional)

The document's creation date, as an ISO-8601 date-time string.

Example
2024-01-15T10:30:00Z
Maximum Length :5050Copied!
modification_datestring(Optional)

The document's last-modification date, as an ISO-8601 date-time string.

Example
2024-01-20T14:45:00Z
Maximum Length :5050Copied!
trappedstring(Optional)

The document's trapping status.

Example
False
Allowed Values :
Show Values ▾
TrueCopied!
FalseCopied!
UnknownCopied!
Copied!Copy all as JSON Array
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 = {
  "title": "Quarterly Review",
  "author": "Jane Smith",
  "subject": "Q3 Financial Summary",
  "keywords": "finance, quarterly, review",
  "creator": "Zoho Writer",
  "producer": "Zoho PDF Editor",
  "creation_date": "2024-01-15T10:30:00Z",
  "modification_date": "2024-01-20T14:45:00Z",
  "trapped": "False"
}

// type: string
password = OpenSesame123
▼ Show full

Response Example

200
Copied!
  {
    "status": "inprogress",
    "status_check_url": "https://www.zohoapis.com/pdfeditor/api/v1/pdf/metadata/update/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.