ESignatureEnvelopeConfig

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

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

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

expirationPeriod

Type: integer

Description: The expiration period for signing.

expirationWarningPeriod

Type: integer

Description: The number of days before expiration for warning notifications.

firstReminderPeriod

Type: integer

Description: The number of days between envelope delivery and the first reminder email.

isExpirationEnabled

Type: boolean

Description: Indicates whether expiration is enabled.

isReminderEnabled

Type: boolean

Description: Indicates whether reminders are enabled.

isVendorDefaultNtfcnEnabled

Type: boolean

Description: Indicates whether the envelope uses account default notification settings.

masterLabel

Type: string

Description: Required.

The name of the setting.

reminderIntervalPeriod

Type: integer

Description: The interval in days between reminder emails.

targetObjectName

Type: string

Description: Required.

The object to which the eSignature applies, such as an Opportunity, Quote, or Order.

vendor

Type: Vendor (enumeration of type string)

Description: Required.

The provider type to which the configuration setting belongs. Currently only DocuSign is supported.

vendorAccountIdentifier

Type: string

Description: The eSignature branding identifier.

Declarative Metadata Sample Definition

The following is an example of an ESignatureEnvelopeConfig component.

1<?xml version="1.0" encoding="UTF-8"?>
2<ESignatureEnvelopeConfig xmlns="http://soap.sforce.com/2021/10/metadata">
3    <masterLabel>DocuSign_Contract</masterLabel>
4    <targetObjectName>Contract</targetObjectName>
5    <vendorAccountIdentifier>vai</vendorAccountIdentifier>
6    <isExpirationEnabled>true</isExpirationEnabled>
7    <expirationPeriod>2</expirationPeriod>
8    <expirationWarningPeriod>2</expirationWarningPeriod>
9    <isReminderEnabled>true</isReminderEnabled>
10    <firstReminderPeriod>2</firstReminderPeriod>
11    <reminderIntervalPeriod>2</reminderIntervalPeriod>
12    <isVendorDefaultNtfcnEnabled>true</isVendorDefaultNtfcnEnabled>
13    <vendor>DocuSign</vendor>
14</ESignatureEnvelopeConfig>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2021/10/metadata">
3    <types>
4        <members>*</members>
5        <name>ESignatureEnvelopeConfig</name>
6    </types>
7    <version>54.0</version>
8</Package>

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.