Skip to content

DocuSign: Updates document visibility for recipients

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

← Esignature operations · Get started

Operation docusign.esignature_recipients_putrecipientsdocumentvisibility

Provider route: PUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility. 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"]["esignatureRecipientsPutRecipientsDocumentVisibility"]>[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.esignatureRecipientsPutRecipientsDocumentVisibility(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_recipients_put_recipients_document_visibility(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
path.envelopeIdstringRequired within parent
bodyModelOptionalExpand Updates document visibility for recipients — response body

Referenced models: Updates document visibility for recipients — 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 Updates document visibility for recipients — response body

Referenced models: Updates document visibility for recipients — response body

Updates document visibility for recipients — response body
FieldTypePresenceDescription and constraints
$objectRootA list of `documentVisibility` objects that specify whether documents are visible to recipients.
documentVisibilityarrayOptionalAn array of `documentVisibility` objects that specifies which documents are visible to which recipients.
documentVisibility[]ModelEach itemExpand Updates document visibility for recipients — response body — document Visibility item

Referenced models: Updates document visibility for recipients — response body — document Visibility item

Updates document visibility for recipients — response body — document Visibility item
FieldTypePresenceDescription and constraints
$objectRootThis object configures a recipient's read/write access to a document.
documentIdstringOptionalSpecifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
recipientIdstringOptionalThe ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object.
rightsstringOptionalIndicates whether the document is editable:

- `editable`
- `read_only`
visiblestringOptionalWhen **true,** the document is visible to the recipient.

Referenced models: Locks a template — response body — error Details

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

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