Salesforce Contracts

Salesforce Contracts
Salesforce Contracts Standard Objects
Apex Reference
Salesforce Contracts Resources
Salesforce Contracts Metadata API Types
ContractType
ESignatureConfig
ESignatureEnvelopeConfig
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ESignatureEnvelopeConfig

Represents the notification-specific settings for integrating with external eSignature providers.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ESignatureEnvelopeConfig components have the suffix .eSignatureEnvelopeConfig and are stored in the eSignatureEnvelopeConfigs folder.

Version

ESignatureEnvelopeConfig components are available in API version 54.0 and later.

Special Access Rules

Fields

Field Name Field Type Description
expirationPeriod integer The expiration period for signing.
expirationWarningPeriod integer The number of days before expiration for warning notifications.
firstReminderPeriod integer The number of days between envelope delivery and the first reminder email.
isExpirationEnabled Indicates whether expiration is enabled.
isReminderEnabled boolean Indicates whether reminders are enabled.
isVendorDefaultNtfcnEnabled boolean Indicates whether the envelope uses account default notification settings.
masterLabel string Required. The name of the setting.
reminderIntervalPeriod integer The interval in days between reminder emails.
targetObjectName string Required. The object to which the eSignature applies, such as an Opportunity, Quote, or Order.
vendor Vendor(enumeration of type string) Required. The provider type to which the configuration setting belongs. Currently only DocuSign is supported.
vendorAccountIdentifier string The eSignature branding identifier.

Declarative Metadata Sample Definition

The following is an example of an ESignatureEnvelopeConfig component.

The following is an example package.xml that references the previous definition.

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.