PDF to WATERMARK-TEXTBOX API

Stamp or watermark a PDF with the text box.

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 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 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.

Show all

Copy parameter's URL TextAlign Watermark text align
Optional

Collection Specifies the watermark text align.

Default: left

Values: left, center, right

Show all

Copy parameter's URL 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

Copy parameter's URL LineSpacing Watermark text line spacing
Optional

Integer Specifies the watermark text line spacing.

Default: 5

Range: 0 .. 30

Show all

Copy parameter's URL 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

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 Height Watermark Height
Optional

Integer Specifies the watermark height.

Default: 500

Range: 10 .. 10000

Show all

Copy parameter's URL Width Watermark width
Optional

Integer Specifies the watermark width.

Default: 500

Range: 10 .. 10000

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

Show parameters

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