Skip to main content

Draw a watermark text inside the PDF.

POST 
/pdf/watermark/text

Draw a watermark text inside the PDF.

Request​

Header Parameters

    ipaas string

Bodyrequired

    urlstring

    The PDF URL.

    bufferstring

    The PDF as a Base64-encoded buffer. Can be specified instead of url.

    getAsUrlboolean

    Whether the result PDF should be returned as a URL. Default is false.

    Example: true
    repeatboolean

    Repeats the text across the entire specified range of the PDF. Default is false

    Example: true
    textstringrequired

    The text to draw.

    Example: Hello, world!
    fontstring

    The font to use. Default is Helvetica.

    Possible values: [Helvetica, Courier, TimesRoman]

    Example: Helvetica
    anchorstring

    The part of the page on which the text should be drawn. Default is center.

    Possible values: [bottom-left, bottom, bottom-right, left, center, right, top-left, top, top-right]

    Example: center
    alignstring

    The part of the text that should be aligned with the specified position. Default is the value of anchor.

    Possible values: [bottom-left, bottom, bottom-right, left, center, right, top-left, top, top-right]

    Example: center
    xnumber

    The horizontal offset in points relative to the anchor. Default is 0.

    Example: 0
    ynumber

    The vertical offset in points relative to the anchor. Default is 0.

    Example: 0
    spacingnumber

    The space between each text. It only applies if repeat is true. Default is 0.

    Example: 45
    rotatenumber

    The counter-clockwise rotation of the text in degrees. Default is 0.

    Example: 45
    sizenumber

    The font size in points. Default is 32.

    Example: 32
    colorstring

    The font color as a six-digit hexcode, i.e. RRGGBB. Default is 000000, i.e. black.

    Example: FFFF00
    pagesstring

    The pages the text should be drawn onto. Given as a range of pages, where 1 means the first page and ^1 means the last page. Default are all Pages.

    Example: 1,3-5,^3-^1
    opacitynumber

    The opacity of the text. Must be between 0 and 1. Default is 1

    Example: 0.5
    fileNamestring

    The file name the result PDF will have. Default is a random ID.

Responses​

Success

Schema
    object