> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # Envelope [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) Description #### Properties `customFields` [CustomField](/docs/salesforce/apex-toolkit-reference/customfield.html) `documents` [Document](/docs/salesforce/apex-toolkit-reference/document.html) `docuSignId` [UUID](/docs/salesforce/apex-toolkit-reference/uuid.html) `emailMessage` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `emailSubject` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `envelopeConfigurationId` [Id](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `error` [APIError](/docs/salesforce/apex-toolkit-reference/apierror.html) `id` [Id](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `name` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `notifications` [Notifications](/docs/salesforce/apex-toolkit-reference/notifications.html) `options` [](/docs/salesforce/apex-toolkit-reference/envelope.html) `recipients` [Recipient](/docs/salesforce/apex-toolkit-reference/recipient.html) `sent` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `source` [Entity](/docs/salesforce/apex-toolkit-reference/entity.html) `transactionId` [UUID](/docs/salesforce/apex-toolkit-reference/uuid.html) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) ### Methods #### Envelope [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [Id](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [UUID](/docs/salesforce/apex-toolkit-reference/uuid.html) [Id](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [Document](/docs/salesforce/apex-toolkit-reference/document.html) [Recipient](/docs/salesforce/apex-toolkit-reference/recipient.html) [CustomField](/docs/salesforce/apex-toolkit-reference/customfield.html) [Notifications](/docs/salesforce/apex-toolkit-reference/notifications.html) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [Entity](/docs/salesforce/apex-toolkit-reference/entity.html) [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) Description Parameters `id` [Id](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `name` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `docuSignId` [UUID](/docs/salesforce/apex-toolkit-reference/uuid.html) `envelopeConfigurationId` [Id](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `documents` [Document](/docs/salesforce/apex-toolkit-reference/document.html) `recipients` [Recipient](/docs/salesforce/apex-toolkit-reference/recipient.html) `customFields` [CustomField](/docs/salesforce/apex-toolkit-reference/customfield.html) `notifications` [Notifications](/docs/salesforce/apex-toolkit-reference/notifications.html) `emailSubject` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `emailMessage` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `source` [Entity](/docs/salesforce/apex-toolkit-reference/entity.html) `sent` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) #### newBulkCopy [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [Recipient](/docs/salesforce/apex-toolkit-reference/recipient.html) Description Returns Parameters `recipient` [Recipient](/docs/salesforce/apex-toolkit-reference/recipient.html) #### newBulkCopy [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [Recipient](/docs/salesforce/apex-toolkit-reference/recipient.html) Description Returns Parameters `recipients` [Recipient](/docs/salesforce/apex-toolkit-reference/recipient.html) #### withCustomFields [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [CustomField](/docs/salesforce/apex-toolkit-reference/customfield.html) Description `customFields` Returns `customFields` Parameters `customFields` [CustomField](/docs/salesforce/apex-toolkit-reference/customfield.html) #### withDocuments [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [Document](/docs/salesforce/apex-toolkit-reference/document.html) Description `documents` Returns `documents` Parameters `documents` [Document](/docs/salesforce/apex-toolkit-reference/document.html) #### withDocuSignId [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [UUID](/docs/salesforce/apex-toolkit-reference/uuid.html) Description `docuSignId` Returns `docuSignId` Parameters `docuSignId` [UUID](/docs/salesforce/apex-toolkit-reference/uuid.html) #### withEmail [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) Description `emailSubject``emailMessage` Returns `emailSubject``emailMessage` Parameters `emailSubject` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `emailMessage` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) #### withNotifications [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [Notifications](/docs/salesforce/apex-toolkit-reference/notifications.html) Description `notifications` Returns `notifications` Parameters `notifications` [Notifications](/docs/salesforce/apex-toolkit-reference/notifications.html) #### withOptions [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) Description `options` Returns `options` Parameters `options` [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) `null` #### withRecipients [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [Recipient](/docs/salesforce/apex-toolkit-reference/recipient.html) Description `recipients` Returns `recipients` Parameters `recipients` [Recipient](/docs/salesforce/apex-toolkit-reference/recipient.html) #### withSent [Envelope](/docs/salesforce/apex-toolkit-reference/envelope.html) [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) Description `sent` Returns `sent` Parameters `sent` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) ## global class Options Description #### Properties `documentWriteBack` [](/docs/salesforce/apex-toolkit-reference/document.html) `envelopeEventUpdates` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) 1. 2. 3. `Closed Won`
`includeDefaultAutoPlaceTags` [Boolean](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `recipientEventUpdates` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) 1. 2. 3. `true`
### Methods #### Options [Boolean](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [](/docs/salesforce/apex-toolkit-reference/document.html) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) Description Parameters `includeDefaultAutoPlaceTags` [Boolean](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `documentWriteBack` [](/docs/salesforce/apex-toolkit-reference/document.html) `envelopeEventUpdates` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `recipientEventUpdates` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) ## global class Status implements Comparable Description #### Properties `completed` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `docuSignId` [UUID](/docs/salesforce/apex-toolkit-reference/uuid.html) `emailSubject` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `expires` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `id` [Id](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `lastStatusUpdate` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `reason` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `recipients` [](/docs/salesforce/apex-toolkit-reference/recipient.html) `senderEmail` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `senderName` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `sent` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `source` [Entity](/docs/salesforce/apex-toolkit-reference/entity.html) `status` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) ### Methods #### Status [Id](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [Entity](/docs/salesforce/apex-toolkit-reference/entity.html) [UUID](/docs/salesforce/apex-toolkit-reference/uuid.html) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [](/docs/salesforce/apex-toolkit-reference/recipient.html) [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) Description Parameters `id` [Id](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `source` [Entity](/docs/salesforce/apex-toolkit-reference/entity.html) `docuSignId` [UUID](/docs/salesforce/apex-toolkit-reference/uuid.html) `status` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `senderName` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `senderEmail` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `recipients` [](/docs/salesforce/apex-toolkit-reference/recipient.html) `sent` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `expires` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `completed` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `emailSubject` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `reason` [String](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm) `lastStatusUpdate` [Datetime](https://www.salesforce.com/us/developer/docs/apexcode/Content/langCon_apex_primitives.htm)