Skip to navigation

EnvelopeShares Resource

View as Markdown

This section shows you how to create and send envelopes.

Methods supported

MethodDescription
createEnvelopesSharesPOST /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares
Creates new envelopes shares
deleteEnvelopesShareDEL /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}
Deletes a single envelope share
deleteEnvelopesSharesDEL /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares
Deletes existing envelopes shares
getEnvelopesShareGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}
Gets a single envelope share by shareId
getEnvelopesSharesGET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares
Gets all shares for an envelope
getSharedEnvelopesGET /restapi/v2.1/accounts/{accountId}/envelopes/shared
Returns a filtered list of shared envelopes.
updateEnvelopesSharePUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares/{shareId}
Updates a single envelope share
updateEnvelopesSharesPUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/shares
Updates existing envelopes shares

EnvelopeShares properties

PropertyTypeDescription
continuationTokenstring
endPositionstringThe last position in the result set.
envelopesarray
envelopeSearchSourcestring
envelopeTransactionStatusesarray
foldersarray
lastQueriedDateTimestring
nextUristringThe URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.
previousUristringThe postal code for the billing address.
resultSetSizestringThe number of results returned in this response.
startPositionstringStarting position of the current result set.
totalSetSizestringThe total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.