Watermark with Image

Purpose

Using this API, you can provide the watermark in the form of image.

HTTP Request URL

https://writer.zoho.com/writer/officeapi/v1/document/watermark

Request Parameters

ParameterData TypeDescription
Mandatory Parameters
apikey423s*****Uniquely identifies the web application in which the Writer editor is integrated.

Body Parameters

ParameterValueDescription
Mandatory Parameters
document

or

url
File

or

String
Method of providing the input file depending on its location.

document - if the input file is from your local drive or desktop.

url - if the input file is from a publicly accessible Web URL.
watermark_settings

{

"image_url": "URL", 

"type": "image"

}

Specify the details of the watermark as JSON.

Specify the watermark image inside the 'image_url' key.

Provide the default value -> 'image' (as the watermark is an image) inside the 'type' key.

You can also set or control other optional functions listed below inside the JSON.

watermark_settings

ParameterTypePossible ValuesDefault Value
orientationstringdiagonal / horizontal / verticaldiagonal
h_allignstringcenter / left / rightcenter
v_allignstringtop / middle / bottommiddle
opacitydouble0.0 to 100.00.0
scale   

Sample Request

Copiedcurl --location --request POST "https://writer.zoho.com/writer/officeapi/v1/document/watermark" \
  --form "apikey=423s*****" \
  --form "document=@" \
  --form "watermark_settings={\"image_url\":\"URL\",\"type\":\"image\"}"