Add Text Watermarks Leave feedback

For a text watermark, you can use various text options like Font, Size, Style, Foreground and Background colors, etc.;
There are many watermark positioning and transforming properties;
There are format-specific options. These options allow to leverage specific format features and often allow to make watermarks stronger;
For protected documents, it is required to provide the password.

The following example demonstrates how to add watermark to the document. Here you can see how to create a watermark with specific text, font, and color, position, and size.

cURL example

Linux/MacOS/Bash

# Get JSON Web Token
# Set your Client Id and Client Secret in the environment variables CLIENT_ID and CLIENT_SECRET.
curl -v "https://api.groupdocs.cloud/connect/token" \
-X POST \
-d "grant_type=client_credentials&client_id=$CLIENT_ID&client_secret=$CLIENT_SECRET" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"

# Add a watermark to a document
curl -v "https://api.groupdocs.cloud/v1.0/watermark" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer $JWT_TOKEN" \
-d '{
    "FileInfo": {
        "FilePath": "documents/sample.pdf"
    },
    "WatermarkDetails": [
        {
            "TextWatermarkOptions": {
                "Text": "Watermark text",
                "FontFamilyName": "Arial",
                "FontSize": 20.0,
                "ForegroundColor": {
                    "Name": "red"
                },
                "TextAlignment": "center",
                "Padding": {
                    "Left": 0,
                    "Top": 0,
                    "Right": 0,
                    "Bottom": 0
                }
            },
            "Position": {
                "X": 0.0,
                "Y": 0.0,
                "Width": 0.0,
                "Height": 0.0,
                "HorizontalAlignment": "Center",
                "RotateAngle": 0.0,
                "ConsiderParentMargins": false,
                "IsBackground": false
            }
        }
    ]
}'

Windows PowerShell

# Get JSON Web Token
# Set your Client Id and Client Secret in the environment variables CLIENT_ID and CLIENT_SECRET.
curl.exe -v "https://api.groupdocs.cloud/connect/token" `
-X POST `
-d "grant_type=client_credentials&client_id=$env:CLIENT_ID&client_secret=$env:CLIENT_SECRET" `
-H "Content-Type: application/x-www-form-urlencoded" `
-H "Accept: application/json"

# Add a watermark to a document
curl.exe -v "https://api.groupdocs.cloud/v1.0/watermark" `
-X POST `
-H "Content-Type: application/json" `
-H "Accept: application/json" `
-H "Authorization: Bearer $env:JWT_TOKEN" `
-d "{
    'FileInfo': {
        'FilePath': 'documents\\sample.pdf'
    },
    'WatermarkDetails': [
        {
            'TextWatermarkOptions': {
                'Text': 'Watermark text',
                'FontFamilyName': 'Arial',
                'FontSize': 20.0,
                'ForegroundColor': {
                    'Name': 'red'
                },
                'TextAlignment': 'center',
                'Padding': {
                    'Left': 0,
                    'Top': 0,
                    'Right': 0,
                    'Bottom': 0
                }
            },
            'Position': {
                'X': 0.0,
                'Y': 0.0,
                'Width': 0.0,
                'Height': 0.0,
                'HorizontalAlignment': 'Center',
                'RotateAngle': 0.0,
                'ConsiderParentMargins': $false,
                'IsBackground': $false
            }
        }
    ]
}"

Windows CMD

:: Get JSON Web Token
:: Set your Client Id and Client Secret in the environment variables CLIENT_ID and CLIENT_SECRET.
curl -v "https://api.groupdocs.cloud/connect/token" ^
-X POST ^
-d "grant_type=client_credentials&client_id=%CLIENT_ID%&client_secret=%CLIENT_SECRET%" ^
-H "Content-Type: application/x-www-form-urlencoded" ^
-H "Accept: application/json"

:: Add a watermark to a document
curl -v "https://api.groupdocs.cloud/v1.0/watermark" ^
-X POST ^
-H "Content-Type: application/json" ^
-H "Accept: application/json" ^
-H "Authorization: Bearer %JWT_TOKEN%" ^
-d "{\"FileInfo\":{\"FilePath\":\"documents\\\\sample.pdf\"},\"WatermarkDetails\":[{\"TextWatermarkOptions\":{\"Text\":\"Watermark text\",\"FontFamilyName\":\"Arial\",\"FontSize\":20.0,\"ForegroundColor\":{\"Name\":\"red\"},\"TextAlignment\":\"center\",\"Padding\":{\"Left\":0,\"Top\":0,\"Right\":0,\"Bottom\":0}},\"Position\":{\"X\":0.0,\"Y\":0.0,\"Width\":0.0,\"Height\":0.0,\"HorizontalAlignment\":\"Center\",\"RotateAngle\":0.0,\"ConsiderParentMargins\":false,\"IsBackground\":false}}]}"

Response

{
    "downloadUrl": "https://api.groupdocs.cloud/v1.0/watermark/storage/file/watermark/added_watermark/documents/sample_pdf/sample.pdf",
    "path": "watermark/added_watermark/documents/sample_pdf/sample.pdf"
}

SDK examples

Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it adds the Watermark API calls and lets you use GroupDocs Cloud features in a native way for your preferred language.

Java

We value your opinion. Your feedback will help us improve our documentation.

Add Text Watermarks Leave feedback

On this page

cURL example

SDK examples

Was this page helpful?

Any additional feedback you'd like to share with us?

Please tell us how we can improve this page.

Thank you for your feedback!

On this page