DocuSign: Update watermark information
DocuSign esignature.esignatureWatermarkPutWatermark: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_watermark_putwatermark
Provider route: PUT /restapi/v2.1/accounts/{accountId}/watermark. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureWatermarkPutWatermark"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.esignature.esignatureWatermarkPutWatermark(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_docusign import DocuSignIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.esignature.esignature_watermark_put_watermark(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
body | Model | Optional | Expand Get watermark preview — response body |
Referenced models: Get watermark preview — response body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get watermark preview — response body |
Referenced models: Get watermark preview — response body
Schemas
Section titled “Schemas”Get watermark preview — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
displayAngle | string | Optional | The display angle of the watermark. Valid values: * 0 (horizontal) * 45 (diagonal) * 90 (vertical) |
enabled | string | Optional | When **true,** the watermark will be applied to documents that are still in progress. When **false,** the watermark will not be applied. |
font | string | Optional | The watermark's font. Valid values: - `courier` - `helvetica` - `timesnewroman` |
fontColor | string | Optional | The watermark's font color. Valid values: * `black` * `blue` * `red` * `gray` * `yellow` |
fontSize | string | Optional | The watermark's font size. Valid values: * `30` * `40` * `50` * `60` * `70` * `80` * `90` |
id | string | Optional | The ID of the watermark. |
imageBase64 | string | Optional | The Base64 representation of the watermark image. This property is read-only. |
transparency | string | Optional | The transparency percentage of the watermark image. Valid values: * `5` * `10` * `15` * `20` * `25` * `30` * `35` * `40` * `45` |
watermarkText | string | Optional | The text for the watermark. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_watermark_putwatermark. Catalog operation: esignature:Watermark_PutWatermark. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.