Delete Pages and Store

Purpose

This API allows you to remove specific pages from a PDF document.

HTTP Request URL

https://{zohoapis_domain}/pdfeditor/api/v1/pdf/pages/delete/store

Body Parameters

ParameterData TypeDescription
Mandatory Parameters

file


 

File

or

String


 

Upload the PDF file from which the pages need to be deleted using one of the following methods:

  • Upload the PDF directly from your local drive or desktop.
  • If the PDF is available via a publicly accessible web URL, you can provide the URL using the same parameter.

Note: The maximum file size allowed for the input PDF is 50 MB. It cannot be more than 150 pages.

input_options

{   

"page_ranges": ["1-5",8,10]
}

page_ranges-> Specify the pages to be deleted. Accepts individual pages or ranges.
output_settings

"name": "<new document name>",

"folder_id": "<folder_id>" ,       

"overwrite_existing_file": "<true/false>"

}

 

Pass the values for 'name' and 'folder_id' via this parameter as JSON.

name -> Specify the name for the modified PDF document.

folder_id -> Specify the ID of the folder in which you would like to store the modified PDF document.

overwrite_existing_file (optional) -> Use this param if you wish to replace an existing file stored in Zoho WorkDrive with the modified PDF document.

Note:

  • This API will only be available for users who have a Zoho WorkDrive account.
  • To use this API, an OAuth token should be generated with the following scopes: ZohoWriter.pdfEditor.ALL,WorkDrive.organization.ALL,WorkDrive.files.ALL

Sample Request

Copiedcurl --location --request POST "https://www.zohoapis.com/pdfeditor/api/v1/pdf/pages/delete/store" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form 'file=@"/Users/username/Documents/Sample.pdf"' \
  --form 'output_settings=“{\”name\”:\”ModifiedFile.pdf\"}"' \
  --form 'input_options=“{\”page_ranges\”:\”1-4,8,10\"}"'

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/delete/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"
}