Request

HTTP request

GET /v2/accounts/{accountId}/watermark

Parameters

Parameter name Value Description
Path parameters
accountId string

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

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Accounts::getWatermark

Definitions Expand All | Collapse All

AccountWatermarks

displayAngle string
enabled string
font string

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
fontColor string

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

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

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
id string
imageBase64 string
transparency string
watermarkText string

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

Examples

Generic JSON Response

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 Response

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>