Replace Pages and Store

Purpose

This API allows you to replace specific pages in an original PDF with pages from a replacement PDF and store the result in Zoho WorkDrive.

Quick Reference

Property	Value
Method	POST
Request URL	https://{zohoapis_domain}/pdfeditor/api/v1/pdf/pages/replace/store

Body Parameters

Parameter	Value	Mandatory/Optional	Description
original_pdf_file	File or String	Mandatory	Upload the PDF file whose pages need to be replaced, from your local drive or desktop, or via a publicly accessible web URL.
replacement_pdf_file	File or String	Mandatory	Upload the PDF file containing the replacement pages, from your local drive or desktop, or via a publicly accessible web URL.
input_options	{ "original_page_ranges": ["1-3", "5"], "replacement_page_ranges": ["1-3", "2"] }	Mandatory	original_page_ranges – Specify the page ranges in the original PDF to be replaced. replacement_page_ranges – Specify the page ranges from the replacement PDF to use.
output_settings	{ "name": "<document_name>", "folder_id": "<folder_id>", "overwrite_existing_file": true \| false }	Mandatory	name – Specify the name for the output PDF document. folder_id – Specify the ID of the WorkDrive folder in which to store the output file. overwrite_existing_file(optional) – Set to true to overwrite an existing file with the same name in the folder.

Notes and Limits

The maximum file size allowed for each input PDF is 50 MB. It cannot be more than 150 pages.
The total number of pages specified in original_page_ranges and replacement_page_ranges must be equal.
This API stores the result in Zoho WorkDrive. A WorkDrive account is required.
To use this API, an OAuth token should be generated with the following scopes: ZohoWriter.pdfEditor.ALL, WorkDrive.files.ALL, WorkDrive.organization.ALL

Possible Errors

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

General Errors

Sample Request

Copiedcurl --location --request POST "https://www.zohoapis.com/pdfeditor/api/v1/pdf/pages/replace/store" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form 'original_pdf_file=@"/Users/username/Documents/Original.pdf"' \
  --form 'replacement_pdf_file=@"/Users/username/Documents/Replacement.pdf"' \
  --form 'input_options=“{\”original_page_ranges\”:\”1-4\",\”replacement_page_ranges\”:\”5-8\"}"' \
  --form 'output_settings=“{\”name\”:\”ModifiedFile.pdf\",\”foder_id\”:\”2b3cdefg5h\"}"'

Once the process begins, you will initially receive the 'status_url'. By invoking the 'status_url', you will be able to monitor the status of the scheduled job.

Sample Response

Copied{
	"status_check_url" : "https://pdf.zoho.com/pdfeditor/api/v1/pdf/pages/replace/job/f931a01183b33",
	"document_url" : "https://workdrive.zoho.com/file/ponazfea04477109f4681a831e7177d96bc40",
	"document_id" : "ponazfea04477109f4681a831e7177d96bc40",
	"status" : "inprogress"
}

Success Response

Copied{
	 "document_url" : "https://workdrive.zoho.com/file/ponazfea04477109f4681a831e7177d96bc40",
	 "document_id" : "ponazfea04477109f4681a831e7177d96bc40",
         "status": "success"
}