Comments: create

Request

HTTP request

POST /v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments

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

Request Body

commentsPublish

Responses

CodeDescriptionReference
201

Successful response.

commentHistoryResult
400

Error encountered.

errorDetails

SDK Method

Envelopes::createEnvelopeComments

Definitions

commentHistoryResult

comments[Comments]

An array of comment tabs that contain information about users' comments on documents.

countinteger

The maximum number of results to return.

endTimetokenstring

startTimetokenstring

commentPublish

idstring

A unique ID for the Salesforce object.

mentions[array]

An array of userIds that are mentioned directly in the body of a comment.

textstring

Specifies the text that is shown in the dropdown list.

threadAnchorKeysobject

threadIdstring

The unique identifier for the comment thread.

visibleTo[array]

commentsPublish

commentsToPublish[commentPublish]

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.

Comments

envelopeIdstring

The envelope's GUID.

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

hmacstring

Reserved for DocuSign.

idstring

A unique ID for the Salesforce object.

mentions[array]

An array of userIds that are mentioned directly in the body of a comment.

readboolean

Indicates if the comment has been read by the target recipient of the comment.

sentByEmailstring

sentByFullNamestring

sentByImageIdstring

Reserved for DocuSign.

sentByInitialsstring

sentByRecipientIdstring

sentByUserIdstring

signingGroupIdstring

Optional. The ID of the signing group.

Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy.

signingGroupNamestring

Optional. The name of the signing group.

Maximum Length: 100 characters.

subjectstring

tabIdstring

The unique identifier for the tab.

textstring

Specifies the text that is shown in the dropdown list.

threadIdstring

The unique identifier for the comment thread.

threadOriginatorIdstring

The userId of the user who created the thread.

timestampstring

timeStampFormattedstring

visibleTo[array]

}} />