PDF to WATERMARK API

Add text watermark to PDF files easily with Watermark PDF API.

API Request:

Copy parameter's URL Secret Secret
Optional

String Authentication secret must be provided as a query parameter. If omitted, token must be provided.

Show all

Copy parameter's URL Token Token
Optional

String Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Show all

Copy parameter's URL File File
Required

File File to be converted. Value can be URL or file content.

Show all

Copy parameter's URL StoreFile Store file
Optional

Bool Store converted file on our secure server and provides download URL.

Default: False

Show all

Copy parameter's URL FileName File name
Optional

String Converted output file name without extension. The extension will be added automatically.

Show all

Copy parameter's URL Timeout Timeout
Optional

Integer Conversion timeout in seconds.

Default: 900

Range: 10 .. 1200

Show all

Copy parameter's URL Async Asynchronous
Optional

Bool Run conversion job asynchronously.

Default: False

Show all

Copy parameter's URL JobId Job ID
Optional

String Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously.

Show all

Copy parameter's URL WebHook WebHook
Optional

String Set WebHook URL to call after asynchronous conversion is finished. Async parameter must be enabled.

Show all

Copy parameter's URL Password Open Password
Optional

String Sets the password to open protected documents.

Show all

Copy parameter's URL Text Watermark text
Required

String Specifies the text to use as watermark. The list of supported variables:

%PAGE% - current page number,
%PAGES% - total number of pages,
%FILENAME% - name of the file,
%WEEKDAY% - full weekday name,
%WEEKDAY_SHORT% - abbreviated weekday name,
%MONTH% - month number (1-12),
%MONTHNAME% - full month name,
%MONTHNAME_SHORT% - abbreviated month name,
%YEAR% - year with century (YYYY),
%YEAR_SHORT% - year without century (YY),
%DAY% - day of month,
%DAY_YEAR% - day of the year (1 -366),
%HOUR% - hour (01- 12),
%HOURS% - hour (00-23),
%MINUTES% - minutes (00-59),
%SECONDS% - seconds (00-59),
%AMPM% - AM PM,
%DATE% - local date representation,
%TIME% - local time representation,
%DATETIME% - local date and time,
%AUTHOR% - document Author,
%TITLE% - document Title,
%SUBJECT% - document Subject,
%KEYWORDS% - document Keywords.

Show all

Copy parameter's URL FontName Watermark font name
Optional

Collection Specifies the watermark font name.

Default: Arial

Values: Academy Engraved LET, AcadEref, Agency FB, Aharoni, AIGDT, Akzidenz-Grotesk Pro Bold Cnd, Akzidenz-Grotesk Pro Cnd, Akzidenz-Grotesk Pro ExtraBold, Akzidenz-Grotesk Pro Light Cnd, Akzidenz-Grotesk Pro Med Cnd, Akzidenz-Grotesk Pro XBd Cnd, Aldhabi, Algerian, AmdtSymbols, American Typewriter, AMGDT, Andalus, Arabic Typesetting, Arial, Arial Black, Arial Narrow, Arial Nova, Arial Nova Cond, Arial Nova Cond Light, Arial Nova Light, Arial Rounded MT Bold, Arimo, Arrow, Avenir LT Std 35 Light, Avenir LT Std 45 Book, Avenir LT Std 55 Roman, Avenir LT Std 65 Medium, AvenirNext LT Pro Bold, AvenirNext LT Pro Cn, AvenirNext LT Pro HeavyCn, AvenirNext LT Pro MediumCn, AvenirNext LT Pro Regular, AvenirNext LT Pro UltLightCn, Bahnschrift, Bahnschrift Condensed, Bahnschrift Light, Bahnschrift Light Condensed, Bahnschrift Light SemiCondensed, Bahnschrift SemiBold, Bahnschrift SemiBold Condensed, Bahnschrift SemiBold SemiConden, Bahnschrift SemiCondensed, Bahnschrift SemiLight, Bahnschrift SemiLight Condensed, Bahnschrift SemiLight SemiConde, BankGothic Lt BT, BankGothic Md BT, Baskerville, Baskerville BT, Baskerville Old Face, Batang, BatangChe, Bauhaus 93, Bell MT, Berlin Sans FB, Berlin Sans FB Demi, Bernard MT Condensed, Binner Gothic, BIZ UDGothic, BIZ UDMincho Medium, BIZ UDPGothic, BIZ UDPMincho Medium, Blackadder ITC, Bodoni, Bodoni Bd BT, Bodoni BdCn BT, Bodoni Bk BT, Bodoni BT, Bodoni MT, Bodoni MT Black, Bodoni MT Condensed, Bodoni MT Poster Compressed, Book Antiqua, Bookman Old Style, Bookshelf Symbol 7, Bosch Office Sans, Botanical, Bradley Hand ITC, Britannic Bold, Broadway, Brush Script, Brush Script MT, Brushstroke Plain, Calibri, Calibri Light, Californian FB, Calisto MT, Cambria, Cambria Math, Candara, Candara Light, Carlito, Castellar, Centaur, Century, Century Gothic, Century Schoolbook, ChalkDust, Chiller, CityBlueprint, Cochin LT, Colonna MT, Comfortaa, Comfortaa Light, Comic Sans MS, CommercialPi BT, CommercialScript BT, Complex, Consolas, Constantia, Cooper Black, Copperplate Gothic Bold, Copperplate Gothic Light, Corbel, Corbel Light, CountryBlueprint, Courier New, Curlz MT, David, DejaVu Sans, DejaVu Sans Condensed, DejaVu Sans Light, DejaVu Sans Mono, DejaVu Serif, DejaVu Serif Condensed, DengXian, DengXian Light, DFKai-SB, Didot, DIN Alternate, DIN Condensed, Dotum, DotumChe, Dutch801 Rm BT, Dutch801 XBd BT, Ebrima, Edwardian Script ITC, Elephant, Engravers MT, Eras Bold ITC, Eras Demi ITC, Eras Light ITC, Eras Medium ITC, Estrangelo Edessa, EuroRoman, Fabrikat, Fabrikat Black, Fabrikat Bold, Fabrikat Bold Italic, Fabrikat Hairline Italic, Fabrikat Italic, Fabrikat Light, Fabrikat Light Italic, Fabrikat Medium, Fabrikat Medium Italic, Fabrikat Thin, Fabrikat Thin Italic, FangSong, Felix Titling, Footlight MT Light, Forte, Franklin Gothic Book, Franklin Gothic Demi, Franklin Gothic Demi Cond, Franklin Gothic Heavy, Franklin Gothic Medium, Franklin Gothic Medium Cond, FrankRuehl, Freestyle Script, French Script MT, Frutiger 55, Frutiger 56, Frutiger 57 Condensed, Frutiger 65, Frutiger 66, Frutiger 67 Condensed, Frutiger 75 Black, Frutiger 76 Black, Frutiger 77 Black Condensed, Frutiger LT Com 47 LightCn, Frutiger LT Com 55 Roman, Frutiger LT Com 57 Condensed, Frutiger LT Pro 45 Light, Frutiger LT Pro 55 Roman, Futura, Futura BdCn BT, Futura Bk BT, Futura CondensedLight, Futura Hv BT, Futura Lt BT, Futura LtCn BT, Futura Md BT, Futura MdCn BT, Futura XBlk BT, Futura XBlkCnIt BT, Futura-Black, Futura-Bold, Gabriola, Gadugi, Garamond, GDT, GENISO, Gentium Basic, Gentium Book Basic, Georgia, Georgia Pro, Georgia Pro Black, Georgia Pro Cond, Georgia Pro Cond Black, Georgia Pro Cond Light, Georgia Pro Cond Semibold, Georgia Pro Light, Georgia Pro Semibold, Gigi, Gill Sans, Gill Sans Condensed, Gill Sans MT, Gill Sans MT Condensed, Gill Sans MT Ext Condensed Bold, Gill Sans Nova, Gill Sans Nova Cond, Gill Sans Nova Cond Lt, Gill Sans Nova Cond Ultra Bold, Gill Sans Nova Cond XBd, Gill Sans Nova Light, Gill Sans Nova Ultra Bold, Gill Sans Ultra Bold, Gill Sans Ultra Bold Condensed, Gisha, Gloucester MT Extra Condensed, GothicE, GothicG, GothicI, Goudy Old Style, Goudy Stout, GreekC, GreekS, Gulim, GulimChe, Gungsuh, GungsuhChe, Haettenschweiler, Harlow Solid Italic, Harrington, High Tower Text, Hoefler Text, HoloLens MDL2 Assets, IDAHC39M Code 39 Barcode, Impact, Imprint MT Shadow, Informal Roman, Ink Free, IowanOldSt BT, ISOCP, ISOCP2, ISOCP3, ISOCPEUR, ISOCT, ISOCT2, ISOCT3, ISOCTEUR, Italic, ItalicC, ItalicT, Javanese Text, Jokerman, Juice ITC, KaiTi, Kartika, Klavika Bold, Klavika Bold Condensed, Klavika Condensed, Klavika Light, Klavika Light Condensed, Klavika Lt, Klavika Md, Klavika Medium Condensed, Klavika Regular, Klavika Rg, Kristen ITC, Kunstler Script, Lato, Lato Black, Lato Hairline, Lato Light, Lavigne, Leelawadee UI, Leelawadee UI Semilight, Letter Gothic, Levenim MT, Lotus Postal Barcode, LotusWP Box, LotusWP Icon, LotusWP Int A, LotusWP Int B, LotusWP Type, Lucia BT, Lucida Bright, Lucida Calligraphy, Lucida Console, Lucida Fax, Lucida Handwriting, Lucida Sans, Lucida Sans Typewriter, Lucida Sans Unicode, Lydian, Magneto, Maiandra GD, Malgun Gothic, Malgun Gothic Semilight, Marker Felt, Marlett, Math A, Math B, Math C, Matura MT Script Capitals, Meiryo, Meiryo UI, Microsoft Himalaya, Microsoft JhengHei, Microsoft JhengHei Light, Microsoft JhengHei UI, Microsoft JhengHei UI Light, Microsoft New Tai Lue, Microsoft PhagsPa, Microsoft Sans Serif, Microsoft Tai Le, Microsoft Uighur, Microsoft YaHei, Microsoft YaHei Light, Microsoft YaHei UI, Microsoft YaHei UI Light, Microsoft Yi Baiti, MingLiU, MingLiU-ExtB, MingLiU_HKSCS, MingLiU_HKSCS-ExtB, Miriam, Miriam Fixed, Mistral, Modern No. 20, Mongolian Baiti, Monospac821 BT, Monotxt, Monotype Corsiva, Monotype Sorts, MS Gothic, MS Mincho, MS PGothic, MS PMincho, MS Reference Sans Serif, MS Reference Specialty, MS UI Gothic, MT Extra, MV Boli, Myanmar Text, Narkisim, Neue Haas Grotesk Text Pro, Neue Haas Grotesk Text Pro Medi, News Gothic, News Gothic Condensed, News Gothic MT, Niagara Engraved, Niagara Solid, Nimrod, Nirmala UI, Nirmala UI Semilight, NSimSun, NYTFranklin ExtraBold, NYTFranklin Light, NYTFranklin Medium, NYTFranklin Semibold, NYTImperial Regular, NYTImperial Semibold, OCR A Extended, Old English Text MT, Olde English, Onyx, OpenSymbol, OPTICopperplate, OPTICopperplate Heavy, OPTICopperplate-Light, Optima, Palace Script MT, Palatino, Palatino Linotype, PanRoman, Papyrus, Parchment, Perpetua, Perpetua Titling MT, Photina Casual Black, Playbill, PMingLiU, PMingLiU-ExtB, Poor Richard, Pristina, Proxy 1, Proxy 2, Proxy 3, Proxy 4, Proxy 5, Proxy 6, Proxy 7, Proxy 8, Proxy 9, PT Serif, Rage Italic, Ravie, Rockwell, Rockwell Condensed, Rockwell Extra Bold, Rockwell Light, Rockwell Nova, Rockwell Nova Cond, Rockwell Nova Cond Light, Rockwell Nova Extra Bold, Rockwell Nova Light, Rod, RomanC, RomanD, RomanS, RomanT, Romantic, Sakkal Majalla, Salesforce Sans, Salesforce Sans Book, Salesforce Sans Light, Salesforce Sans Semibold, Salesforce Sans Thin, SansSerif, Script MT Bold, ScriptC, ScriptS, Segoe MDL2 Assets, Segoe Print, Segoe Script, Segoe UI, Segoe UI Black, Segoe UI Emoji, Segoe UI Historic, Segoe UI Light, Segoe UI Semibold, Segoe UI Semilight, Segoe UI Symbol, Seriffic Grunge, Showcard Gothic, SimHei, Simplex, Simplified Arabic, Simplified Arabic Fixed, SimSun, SimSun-ExtB, Sitka Banner, Sitka Display, Sitka Heading, Sitka Small, Sitka Subheading, Sitka Text, Snap ITC, Source Code Pro, Source Code Pro Black, Source Code Pro ExtraLight, Source Code Pro Light, Source Code Pro Medium, Source Code Pro Semibold, Source Sans Pro, Source Sans Pro Black, Source Sans Pro ExtraLight, Source Sans Pro Light, Source Sans Pro Semibold, Stencil, Stylus BT, Superclarendon Rg, SuperFrench, Swis721 BdCnOul BT, Swis721 BdOul BT, Swis721 Blk BT, Swis721 BlkCn BT, Swis721 BlkEx BT, Swis721 BlkOul BT, Swis721 BT, Swis721 Cn BT, Swis721 Ex BT, Swis721 Lt BT, Swis721 LtCn BT, Swis721 LtEx BT, Syastro, Sylfaen, Symap, Symath, Symbol, Symeteo, Symusic, Tahoma, Technic, TechnicBold, TechnicLite, Tempus Sans ITC, Times New Roman, Traditional Arabic, Trebuchet MS, Tw Cen MT, Tw Cen MT Condensed, Tw Cen MT Condensed Extra Bold, Txt, Ubuntu, Ubuntu Condensed, Ubuntu Light, Ubuntu Mono, UD Digi Kyokasho N-B, UD Digi Kyokasho N-R, UD Digi Kyokasho NK-B, UD Digi Kyokasho NK-R, UD Digi Kyokasho NP-B, UD Digi Kyokasho NP-R, UniversalMath1 BT, Urdu Typesetting, Verdana, Verdana Pro, Verdana Pro Black, Verdana Pro Cond, Verdana Pro Cond Black, Verdana Pro Cond Light, Verdana Pro Cond Semibold, Verdana Pro Light, Verdana Pro Semibold, Viner Hand ITC, Vineta BT, Vivaldi, Vladimir Script, Webdings, Wide Latin, Wingdings, Wingdings 2, Wingdings 3, Wotfard Bold, Wotfard Bold Italic, Wotfard ExtraLight, Wotfard ExtraLight Italic, Wotfard Light, Wotfard Light Italic, Wotfard Medium, Wotfard Medium Italic, Wotfard Regular, Wotfard Regular Italic, Wotfard SemiBold, Wotfard SemiBold Italic, Wotfard Thin, Wotfard Thin Italic, Yu Gothic, Yu Gothic Light, Yu Gothic Medium, Yu Gothic UI, Yu Gothic UI Light, Yu Gothic UI Semibold, Yu Gothic UI Semilight, Yu Mincho, Yu Mincho Demibold, Yu Mincho Light, Zapfino

Show all

Copy parameter's URL FontSize Watermark font size
Optional

Integer Specifies the watermark font size.

Default: 40

Range: 1 .. 200

Show all

Copy parameter's URL FontColor Watermark font color
Optional

String Specifies the watermark font color.

Default: #ffffff

Show all

Copy parameter's URL StrokeColor Stroke color
Optional

String Specifies font stroke color.

Default: #271851

Show all

Copy parameter's URL StrokeWidth Stroke width
Optional

Integer Specifies the stroke width.

Default: 1

Range: 0 .. 200

Show all

Copy parameter's URL FontEmbed Embed watermark font
Optional

Bool Specifies whether fonts should be embedded.

Default: True

Show all

Copy parameter's URL FontSubset Font subset
Optional

Bool Specifies whether fonts should be subset.

Default: True

Show all

Copy parameter's URL FontEncoding Font encoding
Optional

String Specifies the font encoding.

Show all

Copy parameter's URL TextRenderingMode Text rendering mode
Optional

Collection Specifies the text rendering mode.

Default: fillstroke

Values: filltext, stroketext, fillstroke, invisible

Show all

Copy parameter's URL Rotate Rotate watermark
Optional

Integer Specifies the watermark rotation angle in degrees.

Default: 0

Range: 0 .. 360

Show all

Copy parameter's URL PageRange Page Range
Optional

String Set page range. Example 1-10 or 1,2,5.

Default: 1-2000

Show all

Copy parameter's URL Opacity Opacity level
Optional

Integer Specifies watermark opacity level.

Default: 100

Range: 0 .. 100

Show all

Copy parameter's URL Style Watermark style
Optional

Collection Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content.

Default: stamp

Values: stamp, watermark

Show all

Copy parameter's URL GoToLink Go to web link
Optional

String Specifies the web address to go when the watermark is clicked.

Show all

Copy parameter's URL GoToPage Go to page
Optional

String Specifies the page number to go when the watermark is clicked.

Show all

Copy parameter's URL PageRotation Use page rotation
Optional

Bool Specifies whether to use the page rotation parameter when placing watermark.

Default: False

Show all

Copy parameter's URL CropBox Use crop box
Optional

Bool Specifies whether to use the page crop box to position watermark.

Default: False

Show all

Copy parameter's URL HorizontalAlignment Horizontal watermark alignment
Optional

Collection Specifies the horizontal watermark alignment.

Default: center

Values: left, center, right

Show all

Copy parameter's URL VerticalAlignment Vertical watermark alignment
Optional

Collection Specifies the vertical watermark alignment.

Default: center

Values: top, center, bottom

Show all

Copy parameter's URL PositionX Watermark X coordinate
Optional

Integer Specifies the watermark X coordinate. If set overrides property HorizontalAlignment.

Range: 1 .. 10000

Show all

Copy parameter's URL PositionY Watermark Y coordinate
Optional

Integer Specifies the watermark Y coordinate. If set overrides property VerticalAlignment.

Range: 1 .. 10000

Show all

Copy parameter's URL PositionUnit Watermark position unit
Optional

Collection Specifies measurement unit to use for the PositionX and PositionY properties.

Default: pt

Values: pt, in, mm, cm

Show all

Copy parameter's URL EmbedFonts Embed fonts
Optional

Bool Embed fonts in PDF.

Default: True

Show all

Copy parameter's URL SubsetFonts Subset fonts
Optional

Bool Include in the output PDF document only the font characters that are used in the original document.

Default: True

Show all

Copy parameter's URL SubsetFontsThreshold Subset fonts threshold
Optional

Integer Sets the Subset Fonts threshold. If the percentage of used characters, compared with total characters of the particular font, exceeds this threshold, the entire font is embedded.

Default: 100

Range: 0 .. 100

Show all

Copy parameter's URL PdfVersion PDF version
Optional

Collection Set PDF version.

Default: 1.5

Values: 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 2.0

Show all

Copy parameter's URL PdfResolution PDF resolution
Optional

Integer Set PDF resolution.

Default: 300

Range: 10 .. 2400

Show all

Copy parameter's URL PdfTitle PDF title
Optional

String Set the title of the generated PDF file. If value is not set a source document title is used instead.

Show all

Copy parameter's URL PdfSubject PDF subject
Optional

String Set the subject of the generated PDF file. If value is not set a source document subject is used instead.

Show all

Copy parameter's URL PdfAuthor PDF author
Optional

String Set the author of the generated PDF file. If value is not set a source document author is used instead.

Show all

Copy parameter's URL PdfKeywords PDF keywords
Optional

String Set the keywords of the generated PDF file. If value is not set a source document keywords are used instead.

Show all

Copy parameter's URL OpenPage Open to page
Optional

Integer Set the page number at which the PDF document should open.

Default: 1

Range: 1 .. 3000

Show all

Copy parameter's URL OpenZoom PDF default zoom
Optional

Collection Set the default zoom percentage for when you open PDF files .

Default: Default

Values: Default, ActualSize, FitPage, FitWidth, FitHeight, FitVisible, 25, 50, 75, 100, 125, 150, 200, 400, 800, 1600, 2400, 3200, 6400

Show all

Copy parameter's URL RotatePage Auto rotate page
Optional

Collection Automatically rotate pages based on the orientation of the text. By Page option will rotate each page based on the direction of the text on that page. All option will rotate all pages in the document based on the orientation of the majority of text.

Default: Disabled

Values: Disabled, ByPage, All

Show all

Copy parameter's URL ColorSpace PDF color space
Optional

Collection Set PDF color space.

Default: Default

Values: Default, RGB, CMYK, Gray

Show all

Developer mode

Snippets are autogenerated according to converter parameter choices above. Please select file in "File" or "Files" parameter before using code snippets.

Code snippet is using ConvertAPI JavaScript Client

Code snippet is using ConvertAPI Node.js Client

Code snippet is using ConvertAPI PHP Client

Code snippet is using ConvertAPI Java Client

Code snippet is using ConvertAPI C# Client

Code snippet is using ConvertAPI Ruby Client

Code snippet is using ConvertAPI Python Client

Code snippet is using ConvertAPI Go Client

Code snippet is using command line utility program

For conversions with the multiple file result please refer to the example