_all Apex Toolkit

The recipient authentication options.

The email of the recipient.

The email settings for the recipient.

The host email of the recipient. Used only for in-person signing.

The host name of the recipient. Used only for in-person signing.

The ID of the associated dfsle__Recipient__c record.

Read-only property indicating whether the recipient is a signing group.

The name of the recipient.

The private note sent to the recipient.

The phone number of the recipient. Can be used for SMS authentication.

Whether this recipient may be modified. Used with Docusign templates.

Whether this recipient is required. Used with Docusign templates.

The role of the recipient. Used to tie the recipient to Docusign template roles or for use with automatic anchor tags.

The routing order of the recipient. This is distinct from sequence and need not be unique across an envelope's recipients.

The ordinal sequence of the recipient as displayed on the Docusign envelope.

The Docusign signing group.

Whether the recipient should sign now. Honored only for in-person signing or when the first signer is the current user.

The Salesforce source object for the recipient (Contact, Lead, or User).

The type of the recipient.

Signer (Needs to Sign) recipient type constant.

In person signer recipient type constant.

Embedded signer recipient type constant.

Carbon copy (Receives a Copy) recipient type constant.

Certified delivery (Needs to View) recipient type constant.

Agent (Specify Recipients) recipient type constant.

Editor (Allow to Edit) recipient type constant.

Intermediary (Update Recipients) recipient type constant.

Created status constant.

Sent status constant.

Delivered status constant.

Declined status constant.

Completed status constant.

Signed status constant.

Canceled status constant.

The role name.

The role ordinal used for mapping to automatic anchor tags.

Access code a recipient must enter before opening an envelope.

Whether the recipient's ID should be checked.

A list of phone numbers to which a SMS authentication code may be sent. Currently only one phone number is supported.

The language code for the localized emails (e.g 'en', 'pt_BR').

The localized language label.

The localized email message.

The localized email subject.

Date and time when the recipient completed signing the envelope.

The email address of the recipient.

The ID of the underlying dfsle__RecipientStatus__c record.

Date and time when the status was last updated.

The name of the recipient.

The reason the recipient declined signing the envelope.

The routing order of the recipient.

Date and time when the recipient received the envelope.

The recipient sequence.

The Salesforce source entity.

The current status.

The Docusign recipient type.

The recipient email address.

The error encountered during update, if any.

The recipient routing order.

The recipient sequence.

Copies of the Docusign envelope to be sent.

The Docusign bulk send list identifier.

The bulk list identifier.

The name of the bulk send list.

The Salesforce source object from which the list was generated.

Constant for queued status.

Constant for processing status.

Constant for sent status.

Constant for failed status.

The ID of the bulk status record.

A list of validation or sending errors.

Read-only property indicating whether the batch job submission was successful.

The size of the batch.

The Docusign batch job ID.

The number of envelopes that failed to send.

The ID of the status.

Whether or not the status is in a final state.

Date and time when the status was last updated.

The number of envelopes remaining to be sent.

The number of envelopes sent successfully.

The Salesforce source object for the batch.

Date and time when the job was submitted.

Brazilian individual taxpayer registry identification number.

The role or capacity of the signing recipient. Examples: Manager, Approver, etc.

When set to true, the signer is required to fill out this tab.

Corresponds to the optional API property.

Scales the size of the tab. This field accepts values from 0.5 to 2.0, where 0.5 is half the normal size, 1.0 is normal size, and 2.0 is twice the normal size.

Corresponds to the scaleValue API property.

Specifies the text that displays on the button tab.

The file extension of the document.

The ID of the associated dfsle__Document__c record.

Date and time when the document was last modified.

The name of the document.

PDF document options.

The document replacing a template document in an envelope.

The ordinal sequence of the document as it appears in an envelope.

The size of the document in bytes.

The Salesforce source record ID or the Docusign template ID.

Supplemental document options. If this is a non-null value, the document will be treated as supplemental.

The type of the document.

Docusign template document type constant.

Salesforce file/content version document type constant.

Salesforce document type constant.

Use document name for the completed document name. Only valid when all completed documents are written back separately.

Use document name and envelope status for the completed document name. Only valid when all completed documents are written back separately.

Use document name with PDF extension for the completed document name. Only valid when all completed documents are written back separately.

Use document name and replace the extension with PDF for the completed document name. Only valid when all completed documents are written back separately.

Use document name with envelope status and PDF extension for the completed document name. Only valid when all completed documents are written back separately.

Use document name with envelope status and replace the extension with PDF for the completed document name. Only valid when all completed documents are written back separately.

Use envelope name and PDF extension for the completed document name. Only valid when completed documents are combined.

Use envelope name, status, and PDF extension for the completed document name. Only valid when completed documents are combined.

Signer has no mandated interaction with a supplemental document.

Signer must view the supplemental document.

Signer must accept the supplemental document.

Signer must view and accept the supplemental document.

Signer must view, scroll to the end, and accept the supplemental document.

The Salesforce folder ID.

The Salesforce folder name.

The list of Docusign envelope documents contained within the folders.

The list of Salesforce folders.

The envelope sequence of the recipient for whom to assign the transformed PDF tabs. If not a valid positive integer, the transformed tabs will be assigned to the first recipient. Ignored if transformFields is false.

When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the Docusign custom tab dataLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF.

Whether to combine the documents into one PDF.

Whether to include the Certificate of Completion (CoC).

Where to link the completed envelope documents. Defaults to the envelope source ID.

The naming format for the completed envelope documents.

When set to true, the document is included in the combined document download. The default value is true.

Sets how the signer interacts with the supplemental document. Supported constants:

• dfsle.Document.SIGNER_ACKNOWLEDGEMENT_NONE: Signer has no mandated interaction with a supplemental document.
• dfsle.Document.SIGNER_ACKNOWLEDGEMENT_VIEW: Signer must view the supplemental document.
• dfsle.Document.SIGNER_ACKNOWLEDGEMENT_ACCEPT: Signer must accept the supplemental document.
• dfsle.Document.SIGNER_ACKNOWLEDGEMENT_VIEW_ACCEPT: Signer must view and accept the supplemental document.
• dfsle.Document.SIGNER_ACKNOWLEDGEMENT_VIEW_READ_ACCEPT: Signer must view, read, and accept the supplemental document.

The default value is dfsle.Document.SIGNER_ACKNOWLEDGEMENT_NONE.

This property indicates that this formula tab is a payment item.

See Requesting Payments Along with Signatures in the Docusign Support Center to learn more about payments.

Corresponds to the paymentDetails API property.

This is a the tab dataLabel that specifies the amount paid for the line items.

A sender-defined description of the line item.

This is the sender-defined SKU, inventory number, or other item code for the line item.

This is a sender-defined product name, service name, or other designation for the line item.

When true, the payment details will be used to collect payment.

Corresponds to the paymentOption API property.

Specifies the three-letter ISO 4217 currency code for the payment. Supported currencies are:

• AUD: Australian dollar
• CAD: Canadian dollar
• EUR: Euro
• GBP: Great Britain pound
• USD: United States dollar

Specifying any other ISO 4217 code for payments is an error.

The customer ID.

This is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under Description in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports.

A sender-defined field that specifies whether custom metadata is required for the transaction. When set to true, custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account.

A GUID that identifies the payment gateway connected to the sender's Docusign account.

There is no public API for connecting payment gateway accounts You must connect and manage payment gateway accounts through the Docusign Admin console and through your chosen payment gateway. You can get the gateway account ID in the Payments section of the Docusign Admin console.

Corresponds to the gatewayAccountId API property.

A payment formula can have one or more line items that provide detail about individual items in a payment request. The list of line items are returned as metadata to the payment gateway.

An array of accepted payment methods:

• CreditCard
• ApplePay
• AndroidPay
• BankAccount

For example, if you only accept credit cards and ACH transfers, you would set this property to: '["BankAccount", "CreditCard"]'.

Do not specify BankAccount (ACH) if you are also using in-person signing.

Corresponds to the allowedPaymentMethods API property.

When true, the signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.

Corresponds to the paymentOption API property.

The payment source ID.

Corresponds to the paymentSourceId API property.

Validation error messages.

A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field.

Set to true when using a production PIV signature provider or false when testing.

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.

The Docusign signing group ID.

The Docusign signing group name.

The maximum number of tabs within the group that should be checked, populated, or signed. This property is used for validation.

Corresponds to the maximumAllowed API property.

The minimum number of tabs within the group that should be checked, populated, or signed. This property is used for validation.

Corresponds to the minimumRequired API property.

Specifies how minimumTabs and maximumTabs are interpreted when selecting tabs in a group. Possible values are:

• SelectAtLeast
• SelectAtMost
• SelectExactly
• SelectARange

Corresponds to the groupRule API property.

The scope of the tab group. Possible values are:

• document
• envelope (default)

Corresponds to the tabScope API property.

The type of signature provider.

The type of signature provider.

Tab formatting settings.

Specifies the value of the tab.

Tab auto-place settings.

Tab merge field path component types.

Conditional tab settings.

The Docusign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value.

Corresponds with the tabLabel API property.

An array of tab group data labels that uniquely identify tab groups. To assign a tab to a group, you assign the group's dataLabel to this array.

Corresponds to the tabGroupLabels API property.

Tab guided form settings.

The unique identifier for the tab.

Corresponds with the tabId API property.

The name of the tab.

A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same order value, the normal auto-navigation setting behavior for the envelope is used.

Corresponds to the tabOrder API property.

Tab position on the document.

Tab smart contract settings.

The type of the tab. This property is read-only.

The text of a tooltip that appears when a user hovers over a form field or tab.

Docusign envelope recipient tab types.

On which document to apply the tab.

Corresponds to the documentId API property.

The height of the tab in pixels.

Specifies the page number on which the tab is located. For supplemental documents, this value must be 1.

The width of the tab in pixels.

This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. May be zero.

To improve the tab's position on the document, Docusign recommends adjusting the X and Y position coordinates by (-3, -2).

Corresponds to the xPosition API property.

This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. May be zero.

To improve the tab's position on the document, Docusign recommends adjusting the X and Y position coordinates by (-3, -2).

Whether to allow white space in anchor strings.

Corresponds to the anchorAllowWhiteSpaceInCharacters API property.

This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the text property for an anchor tab to be created. The default value is false.

Corresponds to to the anchorCaseSensitive API property.

This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are:

• left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
• right: Aligns the tabs left side with the last character of the matching anchor word.

Corresponds to to the anchorHorizontalAlignment API property.

When set to true, this tab is ignored if the text is not found in the document.

Corresponds to to the anchorIgnoreIfNotPresent API property.

When set to true, the text string in a document must match the value of the text property in its entirety for an anchor tab to be created. The default value is false.

Corresponds to the anchorMatchWholeWord API property.

The string to find in the document and use as the basis for tab placement.

Corresponds to the anchorString API property.

Specifies units of the xOffset and yOffset properties. Valid units are:

• pixels
• inches
• mms
• cms

Corresponds to the anchorUnits API property.

Specifies the X axis location of the tab in units relative to the text.

Specifies the Y axis location of the tab in units relative to the text.

The order in which the guided form HTML should render. The order is relative to the pageLabel, the group by which to place the guided form HTML block.

Corresponds to the formOrder API parameter.