Creates an envelope recipient preview.

https://www.docusign.com/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview

Returns a URL to preview the recipients' view of a draft envelope or template. You can embed this view in your application to enable the sender to preview the recipients' experience. You must specify a `returnUrl` value in the request body. For more information, see Preview and Send.

Access Token Required: API Key

Path Parameters

accountIdstringrequired

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

envelopeIdstringrequired

The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'https://www.docusign.com/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST