Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.

Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the accountSettingsInformation object, set the enableSigningExtensionComments property to true).

Request

HTTP request

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

envelopeIdstring

The envelope's GUID.

Example: 93be49ab-afa0-4adf-933c-f752070d71ec

Optional Query Parameters
encodingstring

(Optional) The encoding to use for the file.

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Envelopes::getCommentsTranscript

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />