Skip to content

DocuSign: Returns a URL to the sender view UI Used before an envelope has been sent

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

← Esignature operations · Get started

Operation docusign.esignature_views_postenvelopesenderview

Provider route: POST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender. 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"]["esignatureViewsPostEnvelopeSenderView"]>[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.esignatureViewsPostEnvelopeSenderView(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_views_post_envelope_sender_view(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 Returns a URL to the edit view UI Use before an envelope has been sent — request body — body

Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns a URL to the edit view UI Use before an envelope has been sent — response body

Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — response body

1 more schema is linked from the tables above, on the schema pages.

Returns a URL to the edit view UI Use before an envelope has been sent — response body
FieldTypePresenceDescription and constraints
$objectRootProvides a URL that you can embed in your application
to provide access to the Docusign UI.

### Related topics

- [Embedded signing and sending](/docs/esign-rest-api/esign101/concepts/embedding/)
- [Send an envelope via your app](/docs/esign-rest-api/how-to/embedded-sending/)
- [Introducing customizable embedded sending](https://www.docusign.com/blog/developers/introducing-customizable-embedded-sending)

urlstringOptionalThe view URL to be navigated to.
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body
FieldTypePresenceDescription and constraints
$objectRoot
returnUrlstringOptional**Required**

Identifies the return point after sending the envelope. Docusign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are:

* send (user sends the envelope)
* save (user saves the envelope)
* cancel (user cancels the sending transaction. No envelopeId is returned in this case.)
* error (there is an error when performing the send)
* sessionEnd (the sending session ends before the user completes another action).
settingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings
Sets the UX for the resulting embedded view.
viewAccessstringOptional**Required** . Set to `envelope`

Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings

Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings
FieldTypePresenceDescription and constraints
$objectRoot
backButtonActionstringOptionalSets the behavior of the back button when clicked. Valid values:
* `previousPage`: Navigate to browser's previous page
* `redirect`: Redirect to the `returnUrl` specified in the request
documentSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings document Settings
Sets the custom document settings.
envelopeCustomFieldSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings envelope Custom Field Settings
Reserved for Docusign.
lockTokenstringOptionalIf your app will modify the envelope after the user finishes editing the envelope, create and use a [lock token](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/) for this attribute. Remember to delete the lock token after your app has finished its envelope modifications.
recipientSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings recipient Settings
sendButtonActionstringOptionalSets the behavior of the send button when clicked. Valid values:
* `send`: send the envelope and redirect with query parameter `event=Send` (default)
* `redirect`: Change the Tagger page's button text to 'Continue'; when clicked, redirect to the `returnUrl` with query parameter `event=Save`. Set `showBackButton` to `false` and `startingScreen` to `Tagger`.
showAdvancedOptionsstringOptionalReserved for Docusign.
showBackButtonstringOptionalDetermines whether the Tagger's back button is shown. Valid values:

* `true`: The back button is shown. This is the default value.
* `false`: Prevents access to the Prepare screen by hiding the back button.
showDiscardActionstringOptionalWhen **true,** the Discard option is shown in the Actions menu. When **false,** the Discard option is not shown. The default value is **true.**
showHeaderActionsstringOptionalDetermines whether the Actions menu displays advanced actions. Valid values:

* `true`: The Actions menu shows all options, including editing the message, recipients, documents, and advanced options. This is the default value.
* `false`: The Actions menu will only show Save, Close, and Discard. To limit the user to tagging only, use this value and set `startingScreen` to `Tagger` and `showBackButton` to `false`.
showSignNowstringOptional
startingScreenstringOptionalDetermines the starting screen for the sender view. Valid values:

* `Prepare` (default)
* `Tagger`
taggerSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings
Sets the custom tagger settings.
templateSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings template Settings
Reserved for Docusign.

Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings document Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings envelope Custom Field Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings recipient Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings template Settings

Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings document Settings
FieldTypePresenceDescription and constraints
$objectRoot
showEditDocumentVisibilitystringOptionalWhen `false`, prevents the user from modifying document visibility settings. The default value is `true`.
showEditDocumentsstringOptionalWhen **false,** prevents the app user from adding, replacing, or deleting documents. The default value is **true.**
showEditPagesstringOptionalWhen `false`, prevents the user from deleting or rotating individual document pages via the thumbnail images. The default value is `true`. If `true` and `showEditDocuments` is `false`, the pages can be rotated but not deleted.
showSaveAsDocumentCustomFieldstringOptionalReserved for Docusign.
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings envelope Custom Field Settings
FieldTypePresenceDescription and constraints
$objectRoot
showEnvelopeCustomFieldsstringOptionalReserved for Docusign.
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings recipient Settings
FieldTypePresenceDescription and constraints
$objectRoot
showBulkSendstringOptionalReserved for Docusign.
showContactsListstringOptionalReserved for Docusign.
showEditMessagestringOptionalReserved for Docusign.
showEditRecipientsstringOptionalWhen `false`, prevents the user from changing the recipients from the **Tagger** page. The default value is `true`.
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings
FieldTypePresenceDescription and constraints
$objectRoot
paletteDefaultstringOptionalWhen `paletteSections` is set to `custom`, this property selects the default tagger palette.
Valid values:
* `custom`
* `merge`
* `notary`
* `seals`
* `smartContracts`
* `annotations`
* `smartSections`
paletteSectionsstringOptionalValid values:

* `default` (default): The default tagger palette UX
* `none`: No tagger palette
* `custom`: Set by `paletteDefault`
paletteSettingsModelOptionalExpand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings palette Settings
Reserved for Docusign.

Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings palette Settings

Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings template Settings
FieldTypePresenceDescription and constraints
$objectRoot
showMatchingTemplatesPromptstringOptionalReserved for Docusign.
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings palette Settings merge
FieldTypePresenceDescription and constraints
$objectRoot
showstringOptionalReserved for Docusign.

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