Docusign eSignature API
Docusign Developer CenterGet a developer account
HomeAPI ReferenceSDKsContext Plugin
Account Watermarks

Update watermark information

PUT
/v2.1/accounts/{accountId}/watermark

Returns information about the watermark for the account.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Request Body

application/json

When true, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark.

When true, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark.

displayAngle?string

The display angle of the watermark. Valid values:

  • 0 (horizontal)
  • 45 (diagonal)
  • 90 (vertical)
enabled?string

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

font?string

The watermark's font. Valid values:

  • courier
  • helvetica
  • timesnewroman
fontColor?string

The watermark's font color. Valid values:

  • black
  • blue
  • red
  • gray
  • yellow
fontSize?string

The watermark's font size. Valid values:

  • 30
  • 40
  • 50
  • 60
  • 70
  • 80
  • 90
id?string

The ID of the watermark.

imageBase64?string

The Base64 representation of the watermark image.

This property is read-only.

transparency?string

The transparency percentage of the watermark image. Valid values:

  • 5
  • 10
  • 15
  • 20
  • 25
  • 30
  • 35
  • 40
  • 45
watermarkText?string

The text for the watermark.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/watermark" \  -H "Content-Type: application/json" \  -d '{}'
{  "displayAngle": "string",  "enabled": "string",  "font": "string",  "fontColor": "string",  "fontSize": "string",  "id": "string",  "imageBase64": "string",  "transparency": "string",  "watermarkText": "string"}

Get watermark information GET

Enables you to preview a watermark specified by the request.

Get watermark preview PUT

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.