Envelope

A list of envelope custom fields. These are not persisted via the dfsle__Envelope__c object.

A list of documents contained by the envelope.

The Docusign ID of the envelope, assigned when the envelope is sent or a draft envelope is created.

The message of the email recipients receive. This is contained within the standard Docusign email body.

The subject of the email recipients receive.

The ID of the configuration used to create the envelope.

The error returned by the API in multi-send scenarios.

The ID of the associated dfsle__Envelope__c record.

The name of the envelope.

The reminder and expiration settings for the envelope.

The envelope options controlling default auto-place text and data and document write-back.

A list of recipients who receive the envelope.

The date and time when the envelope was sent.

The Salesforce source object for the envelope (e.g. Opportunity or Lead).

Sender-generated identifier of the envelope used to prevent envelopes from being sent multiple times in cases where the status is indeterminate. For example, when the network connection drops while waiting for a response. This value is valid in the Docusign system for 7 days.

Created status constant.

Sent status constant.

Delivered status constant.

Declined status constant.

Voided status constant.

Completed status constant.

Document write-back options for completed envelopes.

Map of envelope status to map of field updates. Refer to the dfsle.Envelope.STATUS_* constants for possible keys.

For data write-back to function properly:

1. The envelope must be persisted to the database.
2. The updates must be related to the envelope source object.
3. The sending user must have update permissions on the target objects and fields.

For example, to update Opportunity.StageName to Closed Won when an envelope is complete:

 envelopeEventUpdates = new Map<String, Map<String, Object>> {
   dfsle.Envelope.STATUS_COMPLETED => new Map<String, Object> {
     'StageName' => 'Closed Won'
   }
 };
 

Whether to include default anchor tabs that map to recipient roles.

Map of recipient status to map of field updates. Refer to the dfsle.Recipient.STATUS_* constants for possible keys.

For data write-back to function properly:

1. The envelope must be persisted to the database.
2. The updates must be related to the recipient source object.
3. The sending user must have update permissions on the target objects and fields.

For example, to update Contact.ContractDelivered__c to true when a recipient has received the envelope:

 recipientEventUpdates = new Map<String, Map<String, Object>> {
   dfsle.Recipient.STATUS_DELIVERED => new Map<String, Object> {
     'ContractDelivered__c' => true
   }
 };
 

Date and time when the envelope was completed.

The Docusign envelope ID.

The subject of the email message sent.

Date and time when the envelope expires.

The ID of the underlying dfsle__EnvelopeStatus__c record.

Date and time when the status was last updated.

The reason the envelope was declined or voided.

Associated recipient statuses.

The sender email address.

The sender name.

Date and time when the envelope was sent.

The Salesforce source entity.

The current status.