PDF to WATERMARK-TEXTBOX API
Stamp or watermark a PDF with the text box.
No valid authentication secret or token provided
Timeout
Timeout
Optional
Text
Watermark text
Required
String
Specifies the text to use as text box watermark. The list of supported variables:
%N% - new line,
%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.
TextAlign
Watermark text align
Optional
WordWrap
Watermark text word wrap
Optional
Bool
Specifies whether to enable word wrap in case text does not fit in one line.
Default: False
Show all
LineSpacing
Watermark text line spacing
Optional
FontName
Watermark font name
Optional
Collection
Specifies the watermark font name. Contact us if you are looking for a specific font for a watermark that is missing from the list.
Default: Arial
Values: Arial, Bahnschrift, Calibri, Cambria, Consolas, Constantia, Courier New, Georgia, Tahoma, Times New Roman, Verdana
Show all
FontSize
Watermark font size
Optional
FontColor
Watermark font color
Optional
StrokeWidth
Stroke width
Optional
FontEmbed
Embed watermark font
Optional
FontSubset
Font subset
Optional
TextRenderingMode
Text rendering mode
Optional
Collection
Specifies the text rendering mode.
Default: fillstroke
Values: filltext, stroketext, fillstroke, invisible
Show all
Rotate
Rotate watermark
Optional
PageRange
Page Range
Optional
Opacity
Opacity level
Optional
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
GoToLink
Go to web link
Optional
String
Specifies the web address to go when the watermark is clicked.
GoToPage
Go to page
Optional
String
Specifies the page number to go when the watermark is clicked.
PageRotation
Use page rotation
Optional
Bool
Specifies whether to use the page rotation parameter when placing watermark.
Default: False
Show all
CropBox
Use crop box
Optional
HorizontalAlignment
Horizontal watermark alignment
Optional
Collection
Specifies the horizontal watermark alignment.
Default: center
Values: left, center, right
Show all
VerticalAlignment
Vertical watermark alignment
Optional
Collection
Specifies the vertical watermark alignment.
Default: center
Values: top, center, bottom
Show all
PositionX
Watermark X coordinate
Optional
Integer
Specifies the watermark X coordinate. If set overrides property HorizontalAlignment.
Range: 1 .. 10000
Show all
PositionY
Watermark Y coordinate
Optional
Integer
Specifies the watermark Y coordinate. If set overrides property VerticalAlignment.
Range: 1 .. 10000
Show all
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
Height
Watermark Height
Optional
Width
Watermark width
Optional
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
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
PdfVersion
PDF version
Optional
PdfResolution
PDF resolution
Optional
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.
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.
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.
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.
OpenPage
Open to page
Optional
Integer
Set the page number at which the PDF document should open.
Default: 1
Range: 1 .. 3000
Show all
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
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
ColorSpace
PDF color space
Optional
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