Request

HTTP request

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

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
200

Successful response.

AccountWatermarks
400

Error encountered.

errorDetails

SDK Method

Accounts::getWatermark

Definitions

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

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 to use 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

A unique ID for the Salesforce object.

imageBase64string

transparencystring

watermarkTextstring

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> 
}} />