Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
EnvelopeViews

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

This API method has been replaced by the 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 API method for more information. Backwards compatibility will be provided for a limited time.

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

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

envelopeIdstring required

The envelope's GUID.

Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

Request body

returnUrlstring

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).
viewAccessstring

Required . Set to envelope

Response

Successful response.