Request

HTTP request

PUT /v2/accounts/{accountId}/watermark

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Request Body

AccountWatermarks

Responses

CodeDescriptionReference
200

Successful response.

AccountWatermarks
400

Error encountered.

errorDetails

SDK Method

Accounts::updateWatermark

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

AccountWatermarks

displayAnglestring

enabledstring

fontstring

The font to be used for the tab value. Supported Fonts include:

  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana

fontColorstring

The font color used for the information in the tab. Possible values are:

  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

fontSizestring

The font size used for the information in the tab. Possible values are:

  • Size7
  • Size8
  • Size9
  • Size10
  • Size11
  • Size12
  • Size14
  • Size16
  • Size18
  • Size20
  • Size22
  • Size24
  • Size26
  • Size28
  • Size36
  • Size48
  • Size72

idstring

imageBase64string

transparencystring

watermarkTextstring

Examples

Generic JSON Request/Response

Request
{
  "id": "sample string 1",
  "enabled": "sample string 2",
  "font": "sample string 3",
  "fontSize": "sample string 4",
  "fontColor": "sample string 5",
  "displayAngle": "sample string 6",
  "transparency": "sample string 7",
  "watermarkText": "sample string 8",
  "imageBase64": "sample string 9"
}
Response
{
  "id": "sample string 1",
  "enabled": "sample string 2",
  "font": "sample string 3",
  "fontSize": "sample string 4",
  "fontColor": "sample string 5",
  "displayAngle": "sample string 6",
  "transparency": "sample string 7",
  "watermarkText": "sample string 8",
  "imageBase64": "sample string 9"
}
Generic XML Request/Response

Request
<watermark xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <displayAngle>sample string 6</displayAngle>
  <enabled>sample string 2</enabled>
  <font>sample string 3</font>
  <fontColor>sample string 5</fontColor>
  <fontSize>sample string 4</fontSize>
  <id>sample string 1</id>
  <imageBase64>sample string 9</imageBase64>
  <transparency>sample string 7</transparency>
  <watermarkText>sample string 8</watermarkText>
</watermark> 
Response
<watermark xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <displayAngle>sample string 6</displayAngle>
  <enabled>sample string 2</enabled>
  <font>sample string 3</font>
  <fontColor>sample string 5</fontColor>
  <fontSize>sample string 4</fontSize>
  <id>sample string 1</id>
  <imageBase64>sample string 9</imageBase64>
  <transparency>sample string 7</transparency>
  <watermarkText>sample string 8</watermarkText>
</watermark> 
}} />