Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
AccountWatermarks

Get watermark preview.

Update the watermark for the account.

Note: Many of the request fields must be set to specific values. If you use an invalid value for one of these fields, the endpoint may return 200 OK but set the field to a default value. See the request body for more information.

put/v2.1/accounts/{accountId}/watermark/preview

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

Request body

displayAnglestring

The display angle of the watermark. Valid values:

  • 0 (horizontal)
  • 45 (diagonal)
  • 90 (vertical)
enabledstring

When true, the watermark will be applied to documents that are still in progress. When false, the watermark will not be applied.

fontstring

The watermark's font. Valid values:

  • courier
  • helvetica
  • timesnewroman
fontColorstring

The watermark's font color. Valid values:

  • black
  • blue
  • red
  • gray
  • yellow
fontSizestring

The watermark's font size. Valid values:

  • 30
  • 40
  • 50
  • 60
  • 70
  • 80
  • 90
idstring

The ID of the watermark.

imageBase64string

The Base64 representation of the watermark image.

This property is read-only.

transparencystring

The transparency percentage of the watermark image. Valid values:

  • 5
  • 10
  • 15
  • 20
  • 25
  • 30
  • 35
  • 40
  • 45
watermarkTextstring

The text for the watermark.

Response

Successful response.