Comments Resource

The comments resource provides a method that enables you to download a PDF file containing all of the comments that recipients and the sender have added to the documents in an envelope.

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

For more information, see Comments Settings.

Methods supported

Method	Description
get	GET `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript` Gets a PDF transcript of all of the comments in an envelope.

Comments properties

Property	Type	Description
`envelopeId`	string	The envelope ID of the envelope status that failed to post.
`hmac`	string	Reserved for Docusign.
`id`	string	A unique ID for the Salesforce object.
`mentions`	array	An array of userIds that are mentioned directly in the body of a comment.
`read`	boolean	Indicates if the comment has been read by the target recipient of the comment.
`sentByEmail`	string
`sentByFullName`	string
`sentByImageId`	string	Reserved for Docusign.
`sentByInitials`	string
`sentByRecipientId`	string
`sentByUserId`	string
`signingGroupId`	string	The ID of the signing group.
`signingGroupName`	string	Optional. The name of the signing group. Maximum Length: 100 characters.
`subject`	string
`tabId`	string	The unique identifier for the tab.
`text`	string	Specifies the text that is shown in the dropdown list.
`threadId`	string	The unique identifier for the comment thread.
`threadOriginatorId`	string	The userId of the user who created the thread.
`timestamp`	string
`timeStampFormatted`	string
`visibleTo`	array