Skip to content

DocuSign: Get watermark preview

DocuSign esignature.esignatureWatermarkPreviewPutWatermarkPreview: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_watermarkpreview_putwatermarkpreview

Provider route: PUT /restapi/v2.1/accounts/{accountId}/watermark/preview. Alter supplies the connection’s credentials and routing.

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"]["esignatureWatermarkPreviewPutWatermarkPreview"]>[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.esignatureWatermarkPreviewPutWatermarkPreview(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from 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_preview_put_watermark_preview(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
bodyModelOptionalExpand Get watermark preview — response body

Referenced models: Get watermark preview — response body

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get watermark preview — response body

Referenced models: Get watermark preview — response body

Get watermark preview — response body
FieldTypePresenceDescription and constraints
$objectRoot
displayAnglestringOptionalThe display angle of the watermark. Valid values:

* 0 (horizontal)
* 45 (diagonal)
* 90 (vertical)
enabledstringOptionalWhen **true,** the watermark will be applied to documents that are still in progress. When **false,** the watermark will not be applied.
fontstringOptionalThe watermark's font. Valid values:

- `courier`
- `helvetica`
- `timesnewroman`
fontColorstringOptionalThe watermark's font color. Valid values:

* `black`
* `blue`
* `red`
* `gray`
* `yellow`
fontSizestringOptionalThe watermark's font size. Valid values:

* `30`
* `40`
* `50`
* `60`
* `70`
* `80`
* `90`
idstringOptionalThe ID of the watermark.
imageBase64stringOptionalThe Base64 representation of the watermark image.

This property is read-only.
transparencystringOptionalThe transparency percentage of the watermark image. Valid values:

* `5`
* `10`
* `15`
* `20`
* `25`
* `30`
* `35`
* `40`
* `45`
watermarkTextstringOptionalThe text for the watermark.

SDK function policy ID: docusign.esignature_watermarkpreview_putwatermarkpreview. Catalog operation: esignature:WatermarkPreview_PutWatermarkPreview. 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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.