Share via


Nutrient - Watermark to PDF (Preview)

Secure and brand your documents including PDF and docx, xlsx, pptx Office file formats to add all types of watermarks using Nutrient Document Converter Watermark actions. Effortlessly add text, images, barcodes, QR codes, and shapes to your PDFs for document protection, compliance, and branding.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Nutrient (formerly Muhimbi) Support
URL https://support.nutrient.io/hc/en-us/requests/new
Email support+low-code@nutrient.io
Connector Metadata
Publisher Muhimbi trading as Nutrient
Website https://www.nutrient.io/low-code/
Privacy policy https://www.nutrient.io/legal/privacy/
Categories Collaboration;Content and Files

Add watermarks to PDF files

Use Nutrient Document Converter to add watermarks to PDF and Office files through a REST API or a self-hosted server.

Watermark features

  • Add text watermarks with dynamic fields (date, time, page numbers).
  • Insert graphical elements like lines, rectangles, ellipses, barcodes, RTF files, images, and PDFs.
  • Apply multiple watermarks on the same page or specific page ranges (odd, even, portrait, landscape).

Integration options

Integrate watermarking capabilities using code samples in your preferred language:

Prerequisites

To use Nutrient Document Converter, you need a Free or Trial account. Refer to the comparison guide to understand the differences between these account types.

Getting started

Follow the steps below to start using the Nutrient Document Converter connector:

Known issues and limitations

Documents protected with IRM, DRM, RMS, or AIP solutions cannot be processed due to security restrictions.

For questions or assistance, contact our Support team.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add composite watermark

Add a complex watermark to a PDF file

Add ellipse watermark

Add an ellipse watermark to a PDF file

Add image watermark

Add an image based watermark to a PDF file

Add line watermark

Add a line watermark to a PDF file

Add Linear Barcode watermark

Add a Linear Barcode watermark to a PDF file

Add PDF watermark

Add a PDF based watermark to a PDF file

Add QR Code watermark

Add a QR Code watermark to a PDF file

Add rectangle watermark

Add a rectangle watermark to a PDF file

Add RTF watermark

Add a rich-text watermark to a PDF file

Add text watermark

Add a plain-text watermark to a PDF file

Add composite watermark

Add a complex watermark to a PDF file

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to watermark

Watermark data
watermark_data True string

Watermark data in Muhimbi XML format

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add ellipse watermark

Add an ellipse watermark to a PDF file

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to watermark

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate
x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Y Coordinate
y string

Y Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Fill color
fill_color string

Color in #RRGGBB notation

Line color
line_color string

Color in #RRGGBB notation

Line width
line_width string

Width of the line (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Watermark start section
start_section integer

The first section in a Word or Excel document the watermark is visible

Watermark end section
end_section integer

The last section in a Word or Excel document the watermark is visible

Watermark page type
page_type string

One or more page types for Word and Excel documents, eg. default|first|even

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add image watermark

Add an image based watermark to a PDF file

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to watermark

Image
image_file True byte

Image content or URL

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate
x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Y Coordinate
y string

Y Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Watermark background color
fill_color string

Color in #RRGGBB notation

Watermark outline color
line_color string

Color in #RRGGBB notation

Watermark outline width
line_width string

Width of the watermark outline (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Watermark start section
start_section integer

The first section in a Word or Excel document the watermark is visible

Watermark end section
end_section integer

The last section in a Word or Excel document the watermark is visible

Watermark page type
page_type string

One or more page types for Word and Excel documents, eg. default|first|even

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add line watermark

Add a line watermark to a PDF file

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to watermark

Position
position True enum

Watermark position on the page

X Coordinate (start)
x True string

Start X Coordinate of the line (in Pts, 1/72 of an inch)

Y Coordinate (start)
y True string

Start Y Coordinate of the line (in Pts, 1/72 of an inch)

X Coordinate (end)
end_x True string

End X Coordinate of the line (in Pts, 1/72 of an inch)

Y Coordinate (end)
end_y True string

End Y Coordinate of the line (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Line color
line_color string

Color in #RRGGBB notation

Line width
line_width string

Width of the line (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Watermark start section
start_section integer

The first section in a Word or Excel document the watermark is visible

Watermark end section
end_section integer

The last section in a Word or Excel document the watermark is visible

Watermark page type
page_type string

One or more page types for Word and Excel documents, eg. default|first|even

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add Linear Barcode watermark

Add a Linear Barcode watermark to a PDF file

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to watermark

Barcode content
content True string

Data to embed in the Linear Barcode

Barcode type
barcode_type True enum

The type of the barcode

Omit encoding of start/stop symbols
omit_start_stop_symbols enum

Flag indicating if start and stop symbols have to be encoded into the barcode or not

Disable check digit
disable_checkdigit True enum

Flag indicating if the check digit has to be calculated or not

Show check digit
show_checkdigit True enum

Flag indicating if the check digit should be displayed in the barcode label or not

Margin
margin string

Margin around the barcode

Font family
font_family_name string

Name of the font, e.g. Arial, Times New Roman, Calibri

Font size
font_size string

Size of the font in Pt

Font style
font_style string

One or more styles, e.g. bold|italic|underline|strikeout

Label placement
label_placement enum

Placement of the barcode label

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate
x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Y Coordinate
y string

Y Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Barcode background color
fill_color string

Color in #RRGGBB notation

Barcode bar color
line_color string

Color in #RRGGBB notation

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Watermark start section
start_section integer

The first section in a Word or Excel document the watermark is visible

Watermark end section
end_section integer

The last section in a Word or Excel document the watermark is visible

Watermark page type
page_type string

One or more page types for Word and Excel documents, eg. default|first|even

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add PDF watermark

Add a PDF based watermark to a PDF file

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to watermark

PDF Watermark
pdf_file True byte

PDF watermark content or URL

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate
x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Y Coordinate
y string

Y Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Watermark start section
start_section integer

The first section in a Word or Excel document the watermark is visible

Watermark end section
end_section integer

The last section in a Word or Excel document the watermark is visible

Watermark page type
page_type string

One or more page types for Word and Excel documents, eg. default|first|even

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add QR Code watermark

Add a QR Code watermark to a PDF file

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to watermark

Content
content True string

Data to embed in the QR Code

Version
version True enum

Version

Input mode
input_mode True enum

Input mode

Error correction level
error_correction_level True enum

Error correction level

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate
x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Y Coordinate
y string

Y Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Watermark background color
fill_color string

Color in #RRGGBB notation

Watermark foreground color
line_color string

Color in #RRGGBB notation

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Watermark start section
start_section integer

The first section in a Word or Excel document the watermark is visible

Watermark end section
end_section integer

The last section in a Word or Excel document the watermark is visible

Watermark page type
page_type string

One or more page types for Word and Excel documents, eg. default|first|even

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add rectangle watermark

Add a rectangle watermark to a PDF file

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to watermark

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate
x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Y Coordinate
y string

Y Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Watermark background color
fill_color string

Color in #RRGGBB notation

Watermark outline color
line_color string

Color in #RRGGBB notation

Watermark outline width
line_width string

Width of the watermark outline (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Watermark start section
start_section integer

The first section in a Word or Excel document the watermark is visible

Watermark end section
end_section integer

The last section in a Word or Excel document the watermark is visible

Watermark page type
page_type string

One or more page types for Word and Excel documents, eg. default|first|even

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add RTF watermark

Add a rich-text watermark to a PDF file

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to watermark

Watermark content
rtf_data True string

Watermark text in RTF format

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate
x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Y Coordinate
y string

Y Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Watermark background color
fill_color string

Color in #RRGGBB notation

Watermark outline color
line_color string

Color in #RRGGBB notation

Watermark outline width
line_width string

Width of the watermark outline (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Watermark start section
start_section integer

The first section in a Word or Excel document the watermark is visible

Watermark end section
end_section integer

The last section in a Word or Excel document the watermark is visible

Watermark page type
page_type string

One or more page types for Word and Excel documents, eg. default|first|even

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Add text watermark

Add a plain-text watermark to a PDF file

Parameters

Name Key Required Type Description
Source file name
source_file_name string

Name of the source file including extension

Source file content
source_file_content True byte

Content of the file to watermark

Watermark content
content True string

Watermark text

Font family name
font_family_name True string

Name of the font, e.g. Arial, Times New Roman, Calibri

Font size
font_size True string

Size of the font in Pt

Font color
fill_color True string

Color in #RRGGBB notation

Text alignment
alignment True enum

Text alignment

Word wrap
word_wrap True enum

Spcifies if wordwrap text

Position
position True enum

Watermark position on the page

Width
width True string

Width of the watermark (in Pts, 1/72 of an inch)

Height
height True string

Height of the watermark (in Pts, 1/72 of an inch)

X Coordinate
x string

X Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Y Coordinate
y string

Y Coordinate when 'Position' is set to 'Absolute' (in Pts, 1/72 of an inch)

Layer
layer enum

Watermark layer

Rotation
rotation string

Angle of rotation

Opacity
opacity string

Opacity in % (100 is fully visible and 1 is barely visible)

Font style
font_style string

One or more styles, e.g. bold|italic|underline|strikeout

Font outline color
line_color string

Color in #RRGGBB notation

Font outline width
line_width string

Width of the font outline (in Pts, 1/72 of an inch)

Watermark start page
start_page integer

Number of the first page the watermark applies to

Watermark end page
end_page integer

Number of the last page the watermark applies to

Watermark page interval
page_interval integer

Which pages to display the watermark on (1=every page, 2=every other, etc)

Watermark page orientation
page_orientation enum

Orientation of pages the watermark applies to.

Print only
print_only enum

Tells if the watermark is only visible when the document is printed

Watermark start section
start_section integer

The first section in a Word or Excel document the watermark is visible

Watermark end section
end_section integer

The last section in a Word or Excel document the watermark is visible

Watermark page type
page_type string

One or more page types for Word and Excel documents, eg. default|first|even

Fail on error
fail_on_error boolean

Fail on error

Returns

Response data for all operations

Definitions

operation_response

Response data for all operations

Name Path Type Description
Processed file content
processed_file_content byte

File generated by the Muhimbi converter.

Base file name
base_file_name string

Name of the input file without the extension.

Result code
result_code enum

Operation result code.

Result details
result_details string

Operation result details.