DocuSign: Creates an envelope recipient preview
DocuSign esignature.esignatureViewsPostEnvelopeRecipientPreview: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_views_postenveloperecipientpreview
Provider route: POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview. 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"]["esignatureViewsPostEnvelopeRecipientPreview"]>[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.esignatureViewsPostEnvelopeRecipientPreview(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_views_post_envelope_recipient_preview(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 | |
path.envelopeId | string | Required within parent | |
body | Model | Optional | Expand Creates a template recipient preview — request body — body |
Referenced models: Creates a template recipient preview — request body — 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 Creates a template recipient preview — response body |
Referenced models: Creates a template recipient preview — response body
Schemas
Section titled “Schemas”Creates a template recipient preview — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
url | string | Optional | URL for the template edit view. |
Creates a template recipient preview — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This request object contains the information necessary to create a recipient preview. |
assertionId | string | Optional | A unique identifier of the authentication event executed by the client application. |
authenticationInstant | string | Optional | A sender-generated value that indicates the date and time that the signer was authenticated. |
authenticationMethod | string | Optional | Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. Choose a value from this list: * Biometric * HTTPBasicAuth * Kerberos * KnowledgeBasedAuth * None * PaperDocuments * Password * RSASecureID * SingleSignOn_CASiteminder * SingleSignOn_InfoCard * SingleSignOn_MicrosoftActiveDirectory * SingleSignOn_Other * SingleSignOn_Passport * SingleSignOn_SAML * Smartcard * SSLMutualAuth * X509Certificate This information is included in the Certificate of Completion. |
clientURLs | Model | Optional | Expand Creates a template recipient preview — request body — body client UR Ls |
pingFrequency | string | Optional | Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`. The default is `300` seconds. Valid values are 60-1200 seconds. |
pingUrl | string | Optional | The client URL that the Docusign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received. |
recipientId | string | Optional | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |
returnUrl | string | Optional | The URL to which the user will be redirected in an exit scenario. For example, if the link has expired, the user will be redirected to the URL provided here. This value must be an absolute URL. This property is required. |
securityDomain | string | Optional | The domain in which the user authenticated. |
xFrameOptions | string | Optional | Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames. Valid values are: - `deny`: The page cannot be displayed in a frame. - `same_origin`: The page can only be displayed in a frame on the same origin as the page itself. - `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property. |
xFrameOptionsAllowFromUrl | string | Optional | When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property. |
Referenced models: Creates a template recipient preview — request body — body client UR Ls
Creates a template recipient preview — request body — body client UR Ls
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
onAccessCodeFailed | string | Optional | |
onCancel | string | Optional | |
onDecline | string | Optional | |
onException | string | Optional | |
onFaxPending | string | Optional | |
onIdCheckFailed | string | Optional | |
onSessionTimeout | string | Optional | |
onSigningComplete | string | Optional | |
onTTLExpired | string | Optional | |
onViewingComplete | string | Optional |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_views_postenveloperecipientpreview. Catalog operation: esignature:Views_PostEnvelopeRecipientPreview. 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.