---
title: "Returns a URL to the edit view UI. Use before an envelope has been sent."
method: POST
path: "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit"
tags: ["EnvelopeViews"]
---

# Returns a URL to the edit view UI. Use before an envelope has been sent.

`POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit`

This API method has been replaced by the [EnvelopeViews:createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) API method. The two API methods work exactly the same,

**Migration required**

To solve an application security issue, you must migrate to the new API request format. See the [EnvelopeViews:createSender](/docs/esign-rest-api/reference/envelopes/envelopeviews/createsender/) API method for more information. Backwards compatibility will be provided for a limited time.

## Path parameters

- `accountId` string, required
- `envelopeId` string, required

## Request body

- EnvelopeViewRequest
  - `returnUrl` string — **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).
  - `settings` EnvelopeViewSettings
    - `backButtonAction` string — Sets 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
    - `documentSettings` EnvelopeViewDocumentSettings
      - `showEditDocuments` string — When **false,** prevents the app user from adding, replacing, or deleting documents. The default value is **true.**
      - `showEditDocumentVisibility` string — When `false`, prevents the user from modifying document visibility settings. The default value is `true`.
      - `showEditPages` string — When `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.
      - `showSaveAsDocumentCustomField` string — Reserved for Docusign.
    - `envelopeCustomFieldSettings` EnvelopeViewEnvelopeCustomFieldSettings
      - `showEnvelopeCustomFields` string — Reserved for Docusign.
    - `lockToken` string — If 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.
    - `recipientSettings` EnvelopeViewRecipientSettings
      - `showBulkSend` string — Reserved for Docusign.
      - `showContactsList` string — Reserved for Docusign.
      - `showEditMessage` string — Reserved for Docusign.
      - `showEditRecipients` string — When `false`, prevents the user from changing the recipients from the **Tagger** page. The default value is `true`.
    - `sendButtonAction` string — Sets 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`.
    - `showAdvancedOptions` string — Reserved for Docusign.
    - `showBackButton` string — Determines 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.
    - `showDiscardAction` string — When **true,** the Discard option is shown in the Actions menu. When **false,** the Discard option is not shown. The default value is **true.**
    - `showHeaderActions` string — Determines 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`.
    - `showSignNow` string
    - `startingScreen` string — Determines the starting screen for the sender view. Valid values: * `Prepare` (default) * `Tagger`
    - `taggerSettings` EnvelopeViewTaggerSettings
      - `paletteDefault` string — When `paletteSections` is set to `custom`, this property selects the default tagger palette. Valid values: * `custom` * `merge` * `notary` * `seals` * `smartContracts` * `annotations` * `smartSections`
      - `paletteSections` string — Valid values: * `default` (default): The default tagger palette UX * `none`: No tagger palette * `custom`: Set by `paletteDefault`
      - `paletteSettings` PaletteSettings — Reserved for Docusign.
        - `annotations` PaletteItemSettings
          - `show` string — Reserved for Docusign.
        - `custom` PaletteItemSettings
          - `show` string — Reserved for Docusign.
        - `merge` PaletteItemSettings
          - `show` string — Reserved for Docusign.
        - `notary` PaletteItemSettings
          - `show` string — Reserved for Docusign.
        - `seals` PaletteItemSettings
          - `show` string — Reserved for Docusign.
        - `smartContracts` PaletteItemSettings
          - `show` string — Reserved for Docusign.
        - `smartSections` PaletteItemSettings
          - `show` string — Reserved for Docusign.
    - `templateSettings` EnvelopeViewTemplateSettings
      - `showMatchingTemplatesPrompt` string — Reserved for Docusign.
  - `viewAccess` string — **Required** . Set to `envelope`

## Response `201`

Successful response.

## Other responses

- `400` — Error encountered.

---

[API](https://skmtc.net/docusign/apis/docusign-esignature-rest-api.md) · [All operations](https://skmtc.net/docusign/apis/docusign-esignature-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/docusign/docusign-esignature-rest-api/versions/77f1998c313d/schema)