Update Metadata

Purpose

This API allows you to update metadata fields such as title, author, subject, keywords, and timestamps in a PDF file.

Quick Reference

Property	Value
Method	POST
Request URL (Download)	https://{zohoapis_domain}/pdfeditor/api/v1/pdf/metadata/update
Request URL (Callback)	https://{zohoapis_domain}/pdfeditor/api/v1/pdf/metadata/update/callback

Body Parameters

Parameter	Value	Mandatory/Optional	Description
file	File or String	Mandatory	Upload the PDF file from your local drive or desktop. If the PDF file is available via a publicly accessible web URL, you can provide the URL using the same parameter.
input_options	{ "title": "Document Title", "author": "John Doe", "keywords": "report, analysis", "creation_date": "2026-04-16T10:30:00+05:30" }	Mandatory	Specify the metadata keys to update. At least one supported metadata field must be provided.
password	String	Optional	If the input PDF is password protected, specify the password to unlock it.
callback	{ "invoke_url": "<callback_url>", "timeout": 60, "retry_interval": 60, "headers": { "header_name": "header_value" }, "http_method_type": "post" }	Mandatory for callback variant	Specify the callback delivery configuration for the /callback variant.

Supported Metadata Keys

Parameter	Data Type	Possible Values	Default Value
title	String	Document title	Unchanged when omitted
author	String	Document author	Unchanged when omitted
subject	String	Document subject	Unchanged when omitted
keywords	String	Document keywords	Unchanged when omitted
creator	String	Creator application name	Unchanged when omitted
producer	String	PDF producer name	Unchanged when omitted
creation_date	String	ISO 8601 timestamp	Unchanged when omitted
modification_date	String	ISO 8601 timestamp	Unchanged when omitted
trapped	String	True, False, Unknown	Unchanged when omitted

callback Parameters

Parameter	Data Type	Possible Values	Default Value
invoke_url	String	URL. Maximum length: 300 characters.	–
timeout	Integer	10 to 120 seconds	60 seconds
retry_interval	Integer	60 to 28800 seconds	60 seconds
headers	JSON Object	Maximum 10 keys. Allowed characters for keys: alphabets, numbers, hyphen, underscore, dot. Maximum key length: 100. Maximum value length: 2500.	–
http_method_type	String	put, post	post

Notes and Limits

The maximum file size allowed for the input PDF is 50 MB.
At least one supported metadata key must be provided in input_options.
Only the keys present in the request are updated. Omitted keys are left unchanged.
Date values must use ISO 8601 format.
To use this API, an OAuth token should be generated with the following scopes: ZohoWriter.pdfEditor.ALL

Possible Errors

Refer to the following pages for the list of possible errors for this API:

General Errors

Download Variant Sample Request

Copiedcurl --location --request POST "https://{zohoapis_domain}/pdfeditor/api/v1/pdf/metadata/update" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form 'file=@/Users/username/Documents/Original.pdf' \
  --form 'password="pdf_password"' \
  --form 'input_options={"title": "Document Title", "author": "John Doe", "keywords": "report, analysis", "subject": "Annual Report", "creator": "PDF Creator App", "producer": "Apache PDFBox", "creation_date": "2025-06-16T10:56:00+05:30", "modification_date": "2025-06-16T10:56:00+05:30", "trapped": "False"}'

Callback Variant Sample Request

Copiedcurl --location --request POST "https://{zohoapis_domain}/pdfeditor/api/v1/pdf/metadata/update/callback" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form 'file=@/Users/username/Documents/Original.pdf' \
  --form 'password="pdf_password"' \
  --form 'input_options={"title": "Document Title", "author": "John Doe", "keywords": "report, analysis", "subject": "Annual Report", "creator": "PDF Creator App", "producer": "Apache PDFBox", "creation_date": "2025-06-16T10:56:00+05:30", "modification_date": "2025-06-16T10:56:00+05:30", "trapped": "False"}'
  --form 'callback={"invoke_url": "https://www.example.com/v1/api/callback/savecallback", "timeout": 120, "retry_interval": 60, "http_method_type": "post"}'

Download Variant Sample Response

Copied{
  "status": "inprogress",
  "status_check_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/metadata/update/job/e9051e30fd7f0093cba4247d1f831e03e945a127bde429ed6e9ef3a703b15a6060b830256c650cb88a3f687773c33076"
}

Download Variant Success Response

Copied{
  "status": "success",
  "download_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/metadata/update/download/c9f2e5b8a1d4e7f0c3a6b9d2e5f8a1b4",
  "response_generated_time": 1780912499331
}

Callback Variant Sample Response

Copied{
  "status": "inprogress",
  "status_check_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/metadata/update/job/1d358192770dc68d173ca34b8f7c9dcb121ad0bf3d6307b7387be79e76dacf586f9d62cd253c26020f8c3dcf79d51b6b"
}

Callback Variant Success Response

Copied{
  "status": "success",
  "callback_response": {
    "invoked_time": 1780912655806,
    "http_status_code": 200,
    "message": {
      "download_url": "https://pdf.zoho.com/pdfeditor/api/v1/pdf/metadata/update/download/c9f2e5b8a1d4e7f0c3a6b9d2e5f8a1b4",
      "response_generated_time": 1780912656237
    }
  }
}