| Package | Description |
|---|---|
| com.docusign.esign.api | |
| com.docusign.esign.model |
| Modifier and Type | Method and Description |
|---|---|
EnvelopeUpdateSummary |
EnvelopesApi.update(String accountId,
String envelopeId,
Envelope envelope)
Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft
The Put Envelopes endpoint provides the following functionality:\n\n* Sends the specified single draft envelope.\nAdd {\"status\":\"sent\"} to the request body to send the envelope.\n\n* Voids the specified in-process envelope.\nAdd {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope.\n\n* Replaces the current email subject and message for a draft envelope.\nAdd {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message.\n\n* Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system.\nAdd {\"purgeState\":\"purge type\"} to the request body.\n\n*Additional information on purging documents*\n\nThe purge request can only be used for completed envelopes that are not marked as the authoritative copy.
|
EnvelopeUpdateSummary |
EnvelopesApi.update(String accountId,
String envelopeId,
Envelope envelope,
EnvelopesApi.UpdateOptions options)
Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft
The Put Envelopes endpoint provides the following functionality:\n\n* Sends the specified single draft envelope.\nAdd {\"status\":\"sent\"} to the request body to send the envelope.\n\n* Voids the specified in-process envelope.\nAdd {\"status\":\"voided\", \"voidedReason\":\"The reason for voiding the envelope\"} to the request body to void the envelope.\n\n* Replaces the current email subject and message for a draft envelope.\nAdd {\"emailSubject\":\"subject\", \"emailBlurb\":\"message\"} to the request body to modify the subject and message.\n\n* Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system.\nAdd {\"purgeState\":\"purge type\"} to the request body.\n\n*Additional information on purging documents*\n\nThe purge request can only be used for completed envelopes that are not marked as the authoritative copy.
|
| Modifier and Type | Method and Description |
|---|---|
EnvelopeUpdateSummary |
EnvelopeUpdateSummary.bulkEnvelopeStatus(BulkEnvelopeStatus bulkEnvelopeStatus) |
EnvelopeUpdateSummary |
EnvelopeUpdateSummary.envelopeId(String envelopeId)
The envelope ID of the envelope status that failed to post.
|
EnvelopeUpdateSummary |
EnvelopeUpdateSummary.errorDetails(ErrorDetails errorDetails) |
EnvelopeUpdateSummary |
EnvelopeUpdateSummary.listCustomFieldUpdateResults(List<ListCustomField> listCustomFieldUpdateResults) |
EnvelopeUpdateSummary |
EnvelopeUpdateSummary.lockInformation(LockInformation lockInformation) |
EnvelopeUpdateSummary |
EnvelopeUpdateSummary.recipientUpdateResults(List<RecipientUpdateResponse> recipientUpdateResults) |
EnvelopeUpdateSummary |
EnvelopeUpdateSummary.tabUpdateResults(Tabs tabUpdateResults) |
EnvelopeUpdateSummary |
EnvelopeUpdateSummary.textCustomFieldUpdateResults(List<TextCustomField> textCustomFieldUpdateResults) |
Copyright © 2016. All rights reserved.