Insert Watermark and Store

Purpose

This API allows you to add a text watermark to a PDF and store the result in Zoho WorkDrive.

Quick Reference

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

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 is available via a publicly accessible web URL, you can provide the URL using the same parameter.
input_options	{ "type": "text", "text_info": { "content": "Confidential", "rotation": "diagonal" \| "horizontal", "font_color": "rgb(255,0,0)", "font_family": "Roboto", "font_size": 72, "opacity": 0.4 } }	Mandatory	type(mandatory) – Specifies the watermark type. Only text watermark is supported in this API. text_info – Contains text watermark settings: content(mandatory) – Specify the text to display. rotation(mandatory) – Specify the watermark direction. Possible values: diagonal, horizontal. font_color(optional) – Specify the font color as an RGB value. font_family(optional) – Specify the text font. font_size(optional) – Specify the font size.
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.

input_options Parameters

Parameter	Data Type	Possible Values	Default Value
content	String	Maximum 500 characters	–
rotation	String	diagonal, horizontal	–
font_color	String	RGB value (e.g., rgb(255,0,0))	Black
font_family	String	Web-safe fonts	Roboto
font_size	Integer	Maximum up to 108	72
opacity	Float	Maximum 1.0	0.4

Notes and Limits

The maximum file size allowed for the input PDF is 50 MB. It cannot be more than 150 pages.
Only text watermark is supported in this API. Image watermark is not supported for the store variant.
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/watermark/store" \
  --header "Authorization: Zoho-oauthtoken xxx.yyy.zzz" \
  --form 'file=@"/Users/username/Documents/Sample.pdf"' \
  --form 'input_options="{\"type\":\"image\",\"image_info\":{\"opacity\":\"0.5\",\"height\":\"200\",\"width\":\"200\"}}"'  \
  --form 'output_settings=“{\”name\”:\”ModifiedFile.pdf\"}"'

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/watermark/store/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"
}