Represents a collection of functions to interact with the API endpoints More...
Classes | |
| class | ApplyTemplateOptions |
| Adds templates to an envelope. Adds templates to the specified envelope. More... | |
| class | ApplyTemplateToDocumentOptions |
| Adds templates to a document in an envelope. Adds templates to a document in the specified envelope. More... | |
| class | CreateEnvelopeOptions |
| Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the `document` object ### Recipient Types An `envelopeDefinition` object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an `EnvelopeRecipients` resource object. It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - – – – – – – - | - – – – – – – – – agent (can add name and email information for later recipients/signers) | `agent` carbon copy (receives a copy of the documents) | `carbonCopy` certified delivery (receives a copy of the documents and must acknowledge receipt) | `certifiedDelivery` editor (can change recipients and document fields for later recipients/signers) | `editor` in-person signer ("hosts" someone who signs in-person) | `inPersonSigner` intermediary (can add name and email information for some later recipients/signers.) | `intermediary` signer (signs and/or updates document fields) | `signer` Additional information about the different types of recipients is available from the `EnvelopeRecipients` resource page and from the Developer Center ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an `EnvelopeTabs` resource object. It includes arrays of the 24 different tab types available. See the `EnvelopeTabs` resource for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the `EnvelopeRecipients` object are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the Webhook recipe for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the first template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "\*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a PDF Form Digital Signature Field, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming PDF Form Text Fields, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status. More... | |
| class | CreateRecipientOptions |
| Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to true. More... | |
| class | GetChunkedUploadOptions |
| Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions. More... | |
| class | GetCommentsTranscriptOptions |
| Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true). More... | |
| class | GetConsumerDisclosureDefaultOptions |
| Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure. More... | |
| class | GetConsumerDisclosureOptions |
| Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. More... | |
| class | GetDocumentOptions |
| Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined More... | |
| class | GetDocumentPageImageOptions |
| Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope. More... | |
| class | GetDocumentTabsOptions |
| Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| class | GetEnvelopeOptions |
| Gets the status of a envelope. Retrieves the overall status for the specified envelope. More... | |
| class | GetEnvelopeTransferRulesOptions |
| Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| class | GetPagesOptions |
| Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify. More... | |
| class | GetRecipientInitialsImageOptions |
| Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image. More... | |
| class | GetRecipientSignatureImageOptions |
| Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. More... | |
| class | ListDocumentsOptions |
| Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope. More... | |
| class | ListRecipientsOptions |
| Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. More... | |
| class | ListStatusChangesOptions |
| Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. More... | |
| class | ListStatusOptions |
| Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes. More... | |
| class | ListTabsOptions |
| Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope. More... | |
| class | ListTemplatesForDocumentOptions |
| Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope. More... | |
| class | ListTemplatesOptions |
| Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope. More... | |
| class | UpdateChunkedUploadOptions |
| Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts. More... | |
| class | UpdateEnvelopeDocGenFormFieldsOptions |
| Updates formfields for an envelope More... | |
| class | UpdateOptions |
| Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {"status":"sent"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {"purgeState":"purge type"} to the request body. Additional information on purging documents The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted. More... | |
| class | UpdateRecipientsOptions |
| Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST). More... | |
Public Member Functions | |
| EnvelopesApi (DocuSignClient aplClient) | |
| Initializes a new instance of the EnvelopesApi class using AplClient object More... | |
| String | GetBasePath () |
| Gets the base path of the API client. More... | |
| DocumentTemplateList | ApplyTemplate (string accountId, string envelopeId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateOptions options=null) |
| Adds templates to an envelope. Adds templates to the specified envelope. More... | |
| ApiResponse< DocumentTemplateList > | ApplyTemplateWithHttpInfo (string accountId, string envelopeId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateOptions options=null) |
| Adds templates to an envelope. Adds templates to the specified envelope. More... | |
| async System.Threading.Tasks.Task< DocumentTemplateList > | ApplyTemplateAsync (string accountId, string envelopeId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateOptions options=null) |
| Adds templates to an envelope. Adds templates to the specified envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentTemplateList > > | ApplyTemplateAsyncWithHttpInfo (string accountId, string envelopeId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateOptions options=null) |
| Adds templates to an envelope. Adds templates to the specified envelope. More... | |
| DocumentTemplateList | ApplyTemplateToDocument (string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateToDocumentOptions options=null) |
| Adds templates to a document in an envelope. Adds templates to a document in the specified envelope. More... | |
| ApiResponse< DocumentTemplateList > | ApplyTemplateToDocumentWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateToDocumentOptions options=null) |
| Adds templates to a document in an envelope. Adds templates to a document in the specified envelope. More... | |
| async System.Threading.Tasks.Task< DocumentTemplateList > | ApplyTemplateToDocumentAsync (string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateToDocumentOptions options=null) |
| Adds templates to a document in an envelope. Adds templates to a document in the specified envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentTemplateList > > | ApplyTemplateToDocumentAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateToDocumentOptions options=null) |
| Adds templates to a document in an envelope. Adds templates to a document in the specified envelope. More... | |
| ChunkedUploadResponse | CreateChunkedUpload (string accountId, ChunkedUploadRequest chunkedUploadRequest=null) |
| Initiate a new ChunkedUpload. This method initiates a new chunked upload with the first part of the content. More... | |
| ApiResponse< ChunkedUploadResponse > | CreateChunkedUploadWithHttpInfo (string accountId, ChunkedUploadRequest chunkedUploadRequest=null) |
| Initiate a new ChunkedUpload. This method initiates a new chunked upload with the first part of the content. More... | |
| async System.Threading.Tasks.Task< ChunkedUploadResponse > | CreateChunkedUploadAsync (string accountId, ChunkedUploadRequest chunkedUploadRequest=null) |
| Initiate a new ChunkedUpload. This method initiates a new chunked upload with the first part of the content. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ChunkedUploadResponse > > | CreateChunkedUploadAsyncWithHttpInfo (string accountId, ChunkedUploadRequest chunkedUploadRequest=null) |
| Initiate a new ChunkedUpload. This method initiates a new chunked upload with the first part of the content. More... | |
| ViewUrl | CreateConsoleView (string accountId, ConsoleViewRequest consoleViewRequest=null) |
| Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications. More... | |
| ApiResponse< ViewUrl > | CreateConsoleViewWithHttpInfo (string accountId, ConsoleViewRequest consoleViewRequest=null) |
| Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications. More... | |
| async System.Threading.Tasks.Task< ViewUrl > | CreateConsoleViewAsync (string accountId, ConsoleViewRequest consoleViewRequest=null) |
| Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ViewUrl > > | CreateConsoleViewAsyncWithHttpInfo (string accountId, ConsoleViewRequest consoleViewRequest=null) |
| Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications. More... | |
| ViewUrl | CreateCorrectView (string accountId, string envelopeId, CorrectViewRequest correctViewRequest=null) |
| Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| ApiResponse< ViewUrl > | CreateCorrectViewWithHttpInfo (string accountId, string envelopeId, CorrectViewRequest correctViewRequest=null) |
| Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| async System.Threading.Tasks.Task< ViewUrl > | CreateCorrectViewAsync (string accountId, string envelopeId, CorrectViewRequest correctViewRequest=null) |
| Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ViewUrl > > | CreateCorrectViewAsyncWithHttpInfo (string accountId, string envelopeId, CorrectViewRequest correctViewRequest=null) |
| Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| CustomFields | CreateCustomFields (string accountId, string envelopeId, CustomFields customFields=null) |
| Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name. More... | |
| ApiResponse< CustomFields > | CreateCustomFieldsWithHttpInfo (string accountId, string envelopeId, CustomFields customFields=null) |
| Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name. More... | |
| async System.Threading.Tasks.Task< CustomFields > | CreateCustomFieldsAsync (string accountId, string envelopeId, CustomFields customFields=null) |
| Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name. More... | |
| async System.Threading.Tasks.Task< ApiResponse< CustomFields > > | CreateCustomFieldsAsyncWithHttpInfo (string accountId, string envelopeId, CustomFields customFields=null) |
| Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name. More... | |
| DocumentFieldsInformation | CreateDocumentFields (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document. More... | |
| ApiResponse< DocumentFieldsInformation > | CreateDocumentFieldsWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document. More... | |
| async System.Threading.Tasks.Task< DocumentFieldsInformation > | CreateDocumentFieldsAsync (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > > | CreateDocumentFieldsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document. More... | |
| DocumentHtmlDefinitions | CreateDocumentResponsiveHtmlPreview (string accountId, string envelopeId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null) |
| Get Responsive HTML Preview for a document in an envelope. Creates a preview of the responsive HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document. More... | |
| ApiResponse< DocumentHtmlDefinitions > | CreateDocumentResponsiveHtmlPreviewWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null) |
| Get Responsive HTML Preview for a document in an envelope. Creates a preview of the responsive HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document. More... | |
| async System.Threading.Tasks.Task< DocumentHtmlDefinitions > | CreateDocumentResponsiveHtmlPreviewAsync (string accountId, string envelopeId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null) |
| Get Responsive HTML Preview for a document in an envelope. Creates a preview of the responsive HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitions > > | CreateDocumentResponsiveHtmlPreviewAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentHtmlDefinition documentHtmlDefinition=null) |
| Get Responsive HTML Preview for a document in an envelope. Creates a preview of the responsive HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document. More... | |
| Tabs | CreateDocumentTabs (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Adds the tabs to an envelope document Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ``` More... | |
| ApiResponse< Tabs > | CreateDocumentTabsWithHttpInfo (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Adds the tabs to an envelope document Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ``` More... | |
| async System.Threading.Tasks.Task< Tabs > | CreateDocumentTabsAsync (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Adds the tabs to an envelope document Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ``` More... | |
| async System.Threading.Tasks.Task< ApiResponse< Tabs > > | CreateDocumentTabsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Adds the tabs to an envelope document Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ``` More... | |
| ViewUrl | CreateEditView (string accountId, string envelopeId, ReturnUrlRequest returnUrlRequest=null) |
| Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| ApiResponse< ViewUrl > | CreateEditViewWithHttpInfo (string accountId, string envelopeId, ReturnUrlRequest returnUrlRequest=null) |
| Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| async System.Threading.Tasks.Task< ViewUrl > | CreateEditViewAsync (string accountId, string envelopeId, ReturnUrlRequest returnUrlRequest=null) |
| Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ViewUrl > > | CreateEditViewAsyncWithHttpInfo (string accountId, string envelopeId, ReturnUrlRequest returnUrlRequest=null) |
| Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| EmailSettings | CreateEmailSettings (string accountId, string envelopeId, EmailSettings emailSettings=null) |
| Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type. More... | |
| ApiResponse< EmailSettings > | CreateEmailSettingsWithHttpInfo (string accountId, string envelopeId, EmailSettings emailSettings=null) |
| Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type. More... | |
| async System.Threading.Tasks.Task< EmailSettings > | CreateEmailSettingsAsync (string accountId, string envelopeId, EmailSettings emailSettings=null) |
| Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EmailSettings > > | CreateEmailSettingsAsyncWithHttpInfo (string accountId, string envelopeId, EmailSettings emailSettings=null) |
| Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type. More... | |
| EnvelopeSummary | CreateEnvelope (string accountId, EnvelopeDefinition envelopeDefinition=null, EnvelopesApi.CreateEnvelopeOptions options=null) |
| Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the `document` object ### Recipient Types An `envelopeDefinition` object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an `EnvelopeRecipients` resource object. It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - – – – – – – - | - – – – – – – – – agent (can add name and email information for later recipients/signers) | `agent` carbon copy (receives a copy of the documents) | `carbonCopy` certified delivery (receives a copy of the documents and must acknowledge receipt) | `certifiedDelivery` editor (can change recipients and document fields for later recipients/signers) | `editor` in-person signer ("hosts" someone who signs in-person) | `inPersonSigner` intermediary (can add name and email information for some later recipients/signers.) | `intermediary` signer (signs and/or updates document fields) | `signer` Additional information about the different types of recipients is available from the `EnvelopeRecipients` resource page and from the Developer Center ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an `EnvelopeTabs` resource object. It includes arrays of the 24 different tab types available. See the `EnvelopeTabs` resource for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the `EnvelopeRecipients` object are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the Webhook recipe for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the first template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "\*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a PDF Form Digital Signature Field, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming PDF Form Text Fields, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status. More... | |
| ApiResponse< EnvelopeSummary > | CreateEnvelopeWithHttpInfo (string accountId, EnvelopeDefinition envelopeDefinition=null, EnvelopesApi.CreateEnvelopeOptions options=null) |
| Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the `document` object ### Recipient Types An `envelopeDefinition` object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an `EnvelopeRecipients` resource object. It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - – – – – – – - | - – – – – – – – – agent (can add name and email information for later recipients/signers) | `agent` carbon copy (receives a copy of the documents) | `carbonCopy` certified delivery (receives a copy of the documents and must acknowledge receipt) | `certifiedDelivery` editor (can change recipients and document fields for later recipients/signers) | `editor` in-person signer ("hosts" someone who signs in-person) | `inPersonSigner` intermediary (can add name and email information for some later recipients/signers.) | `intermediary` signer (signs and/or updates document fields) | `signer` Additional information about the different types of recipients is available from the `EnvelopeRecipients` resource page and from the Developer Center ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an `EnvelopeTabs` resource object. It includes arrays of the 24 different tab types available. See the `EnvelopeTabs` resource for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the `EnvelopeRecipients` object are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the Webhook recipe for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the first template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "\*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a PDF Form Digital Signature Field, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming PDF Form Text Fields, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status. More... | |
| async System.Threading.Tasks.Task< EnvelopeSummary > | CreateEnvelopeAsync (string accountId, EnvelopeDefinition envelopeDefinition=null, EnvelopesApi.CreateEnvelopeOptions options=null) |
| Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the `document` object ### Recipient Types An `envelopeDefinition` object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an `EnvelopeRecipients` resource object. It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - – – – – – – - | - – – – – – – – – agent (can add name and email information for later recipients/signers) | `agent` carbon copy (receives a copy of the documents) | `carbonCopy` certified delivery (receives a copy of the documents and must acknowledge receipt) | `certifiedDelivery` editor (can change recipients and document fields for later recipients/signers) | `editor` in-person signer ("hosts" someone who signs in-person) | `inPersonSigner` intermediary (can add name and email information for some later recipients/signers.) | `intermediary` signer (signs and/or updates document fields) | `signer` Additional information about the different types of recipients is available from the `EnvelopeRecipients` resource page and from the Developer Center ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an `EnvelopeTabs` resource object. It includes arrays of the 24 different tab types available. See the `EnvelopeTabs` resource for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the `EnvelopeRecipients` object are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the Webhook recipe for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the first template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "\*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a PDF Form Digital Signature Field, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming PDF Form Text Fields, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeSummary > > | CreateEnvelopeAsyncWithHttpInfo (string accountId, EnvelopeDefinition envelopeDefinition=null, EnvelopesApi.CreateEnvelopeOptions options=null) |
| Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the `document` object ### Recipient Types An `envelopeDefinition` object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an `EnvelopeRecipients` resource object. It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - – – – – – – - | - – – – – – – – – agent (can add name and email information for later recipients/signers) | `agent` carbon copy (receives a copy of the documents) | `carbonCopy` certified delivery (receives a copy of the documents and must acknowledge receipt) | `certifiedDelivery` editor (can change recipients and document fields for later recipients/signers) | `editor` in-person signer ("hosts" someone who signs in-person) | `inPersonSigner` intermediary (can add name and email information for some later recipients/signers.) | `intermediary` signer (signs and/or updates document fields) | `signer` Additional information about the different types of recipients is available from the `EnvelopeRecipients` resource page and from the Developer Center ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an `EnvelopeTabs` resource object. It includes arrays of the 24 different tab types available. See the `EnvelopeTabs` resource for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the `EnvelopeRecipients` object are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the Webhook recipe for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the first template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "\*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a PDF Form Digital Signature Field, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming PDF Form Text Fields, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status. More... | |
| CommentHistoryResult | CreateEnvelopeComments (string accountId, string envelopeId, CommentsPublish commentsPublish=null) |
| Posts a list of comments for authorized user More... | |
| ApiResponse< CommentHistoryResult > | CreateEnvelopeCommentsWithHttpInfo (string accountId, string envelopeId, CommentsPublish commentsPublish=null) |
| Posts a list of comments for authorized user More... | |
| async System.Threading.Tasks.Task< CommentHistoryResult > | CreateEnvelopeCommentsAsync (string accountId, string envelopeId, CommentsPublish commentsPublish=null) |
| Posts a list of comments for authorized user More... | |
| async System.Threading.Tasks.Task< ApiResponse< CommentHistoryResult > > | CreateEnvelopeCommentsAsyncWithHttpInfo (string accountId, string envelopeId, CommentsPublish commentsPublish=null) |
| Posts a list of comments for authorized user More... | |
| ViewUrl | CreateEnvelopeRecipientPreview (string accountId, string envelopeId, RecipientPreviewRequest recipientPreviewRequest=null) |
| Provides a URL to start a recipient view of the Envelope UI This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send. More... | |
| ApiResponse< ViewUrl > | CreateEnvelopeRecipientPreviewWithHttpInfo (string accountId, string envelopeId, RecipientPreviewRequest recipientPreviewRequest=null) |
| Provides a URL to start a recipient view of the Envelope UI This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send. More... | |
| async System.Threading.Tasks.Task< ViewUrl > | CreateEnvelopeRecipientPreviewAsync (string accountId, string envelopeId, RecipientPreviewRequest recipientPreviewRequest=null) |
| Provides a URL to start a recipient view of the Envelope UI This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ViewUrl > > | CreateEnvelopeRecipientPreviewAsyncWithHttpInfo (string accountId, string envelopeId, RecipientPreviewRequest recipientPreviewRequest=null) |
| Provides a URL to start a recipient view of the Envelope UI This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send. More... | |
| ViewUrl | CreateEnvelopeRecipientSharedView (string accountId, string envelopeId, RecipientViewRequest recipientViewRequest=null) |
| Provides a URL to start a shared recipient view of the Envelope UI Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - Embedded signing and sending - How to send an envelope via your app - How to embed the DocuSign UI in your app More... | |
| ApiResponse< ViewUrl > | CreateEnvelopeRecipientSharedViewWithHttpInfo (string accountId, string envelopeId, RecipientViewRequest recipientViewRequest=null) |
| Provides a URL to start a shared recipient view of the Envelope UI Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - Embedded signing and sending - How to send an envelope via your app - How to embed the DocuSign UI in your app More... | |
| async System.Threading.Tasks.Task< ViewUrl > | CreateEnvelopeRecipientSharedViewAsync (string accountId, string envelopeId, RecipientViewRequest recipientViewRequest=null) |
| Provides a URL to start a shared recipient view of the Envelope UI Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - Embedded signing and sending - How to send an envelope via your app - How to embed the DocuSign UI in your app More... | |
| async System.Threading.Tasks.Task< ApiResponse< ViewUrl > > | CreateEnvelopeRecipientSharedViewAsyncWithHttpInfo (string accountId, string envelopeId, RecipientViewRequest recipientViewRequest=null) |
| Provides a URL to start a shared recipient view of the Envelope UI Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - Embedded signing and sending - How to send an envelope via your app - How to embed the DocuSign UI in your app More... | |
| EnvelopeTransferRuleInformation | CreateEnvelopeTransferRules (string accountId, EnvelopeTransferRuleRequest envelopeTransferRuleRequest=null) |
| Add envelope transfer rules to an account. This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| ApiResponse< EnvelopeTransferRuleInformation > | CreateEnvelopeTransferRulesWithHttpInfo (string accountId, EnvelopeTransferRuleRequest envelopeTransferRuleRequest=null) |
| Add envelope transfer rules to an account. This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| async System.Threading.Tasks.Task< EnvelopeTransferRuleInformation > | CreateEnvelopeTransferRulesAsync (string accountId, EnvelopeTransferRuleRequest envelopeTransferRuleRequest=null) |
| Add envelope transfer rules to an account. This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeTransferRuleInformation > > | CreateEnvelopeTransferRulesAsyncWithHttpInfo (string accountId, EnvelopeTransferRuleRequest envelopeTransferRuleRequest=null) |
| Add envelope transfer rules to an account. This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| WorkflowStep | CreateEnvelopeWorkflowStepDefinition (string accountId, string envelopeId, WorkflowStep workflowStep=null) |
| Creates and adds a new workflow step definition for an envelope's workflow More... | |
| ApiResponse< WorkflowStep > | CreateEnvelopeWorkflowStepDefinitionWithHttpInfo (string accountId, string envelopeId, WorkflowStep workflowStep=null) |
| Creates and adds a new workflow step definition for an envelope's workflow More... | |
| async System.Threading.Tasks.Task< WorkflowStep > | CreateEnvelopeWorkflowStepDefinitionAsync (string accountId, string envelopeId, WorkflowStep workflowStep=null) |
| Creates and adds a new workflow step definition for an envelope's workflow More... | |
| async System.Threading.Tasks.Task< ApiResponse< WorkflowStep > > | CreateEnvelopeWorkflowStepDefinitionAsyncWithHttpInfo (string accountId, string envelopeId, WorkflowStep workflowStep=null) |
| Creates and adds a new workflow step definition for an envelope's workflow More... | |
| EnvelopePublishTransaction | CreateHistoricalEnvelopePublishTransaction (string accountId, ConnectHistoricalEnvelopeRepublish connectHistoricalEnvelopeRepublish=null) |
| Submits a batch of historical envelopes for republish to an adhoc config. More... | |
| ApiResponse< EnvelopePublishTransaction > | CreateHistoricalEnvelopePublishTransactionWithHttpInfo (string accountId, ConnectHistoricalEnvelopeRepublish connectHistoricalEnvelopeRepublish=null) |
| Submits a batch of historical envelopes for republish to an adhoc config. More... | |
| async System.Threading.Tasks.Task< EnvelopePublishTransaction > | CreateHistoricalEnvelopePublishTransactionAsync (string accountId, ConnectHistoricalEnvelopeRepublish connectHistoricalEnvelopeRepublish=null) |
| Submits a batch of historical envelopes for republish to an adhoc config. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopePublishTransaction > > | CreateHistoricalEnvelopePublishTransactionAsyncWithHttpInfo (string accountId, ConnectHistoricalEnvelopeRepublish connectHistoricalEnvelopeRepublish=null) |
| Submits a batch of historical envelopes for republish to an adhoc config. More... | |
| LockInformation | CreateLock (string accountId, string envelopeId, LockRequest lockRequest=null) |
| Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user). More... | |
| ApiResponse< LockInformation > | CreateLockWithHttpInfo (string accountId, string envelopeId, LockRequest lockRequest=null) |
| Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user). More... | |
| async System.Threading.Tasks.Task< LockInformation > | CreateLockAsync (string accountId, string envelopeId, LockRequest lockRequest=null) |
| Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user). More... | |
| async System.Threading.Tasks.Task< ApiResponse< LockInformation > > | CreateLockAsyncWithHttpInfo (string accountId, string envelopeId, LockRequest lockRequest=null) |
| Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user). More... | |
| Recipients | CreateRecipient (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.CreateRecipientOptions options=null) |
| Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to true. More... | |
| ApiResponse< Recipients > | CreateRecipientWithHttpInfo (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.CreateRecipientOptions options=null) |
| Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to true. More... | |
| async System.Threading.Tasks.Task< Recipients > | CreateRecipientAsync (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.CreateRecipientOptions options=null) |
| Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to true. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Recipients > > | CreateRecipientAsyncWithHttpInfo (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.CreateRecipientOptions options=null) |
| Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to true. More... | |
| ViewUrl | CreateRecipientManualReviewView (string accountId, string envelopeId, string recipientId) |
| Provides a link to access the Identity manual review related to a recipient. This method returns the URL of the page that allows a sender to manually review the ID of a recipient. More... | |
| ApiResponse< ViewUrl > | CreateRecipientManualReviewViewWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Provides a link to access the Identity manual review related to a recipient. This method returns the URL of the page that allows a sender to manually review the ID of a recipient. More... | |
| async System.Threading.Tasks.Task< ViewUrl > | CreateRecipientManualReviewViewAsync (string accountId, string envelopeId, string recipientId) |
| Provides a link to access the Identity manual review related to a recipient. This method returns the URL of the page that allows a sender to manually review the ID of a recipient. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ViewUrl > > | CreateRecipientManualReviewViewAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Provides a link to access the Identity manual review related to a recipient. This method returns the URL of the page that allows a sender to manually review the ID of a recipient. More... | |
| IdEvidenceViewLink | CreateRecipientProofFileLink (string accountId, string envelopeId, string recipientId) |
| Returns a link to access to the identity events stored in the proof service related to this recipient. More... | |
| ApiResponse< IdEvidenceViewLink > | CreateRecipientProofFileLinkWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Returns a link to access to the identity events stored in the proof service related to this recipient. More... | |
| async System.Threading.Tasks.Task< IdEvidenceViewLink > | CreateRecipientProofFileLinkAsync (string accountId, string envelopeId, string recipientId) |
| Returns a link to access to the identity events stored in the proof service related to this recipient. More... | |
| async System.Threading.Tasks.Task< ApiResponse< IdEvidenceViewLink > > | CreateRecipientProofFileLinkAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Returns a link to access to the identity events stored in the proof service related to this recipient. More... | |
| IdEvidenceResourceToken | CreateRecipientProofFileResourceToken (string tokenScopes, string accountId, string envelopeId, string recipientId) |
| Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API. More... | |
| ApiResponse< IdEvidenceResourceToken > | CreateRecipientProofFileResourceTokenWithHttpInfo (string tokenScopes, string accountId, string envelopeId, string recipientId) |
| Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API. More... | |
| async System.Threading.Tasks.Task< IdEvidenceResourceToken > | CreateRecipientProofFileResourceTokenAsync (string tokenScopes, string accountId, string envelopeId, string recipientId) |
| Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API. More... | |
| async System.Threading.Tasks.Task< ApiResponse< IdEvidenceResourceToken > > | CreateRecipientProofFileResourceTokenAsyncWithHttpInfo (string tokenScopes, string accountId, string envelopeId, string recipientId) |
| Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API. More... | |
| ViewUrl | CreateRecipientView (string accountId, string envelopeId, RecipientViewRequest recipientViewRequest=null) |
| Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity. More... | |
| ApiResponse< ViewUrl > | CreateRecipientViewWithHttpInfo (string accountId, string envelopeId, RecipientViewRequest recipientViewRequest=null) |
| Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity. More... | |
| async System.Threading.Tasks.Task< ViewUrl > | CreateRecipientViewAsync (string accountId, string envelopeId, RecipientViewRequest recipientViewRequest=null) |
| Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ViewUrl > > | CreateRecipientViewAsyncWithHttpInfo (string accountId, string envelopeId, RecipientViewRequest recipientViewRequest=null) |
| Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity. More... | |
| DocumentHtmlDefinitions | CreateResponsiveHtmlPreview (string accountId, string envelopeId, DocumentHtmlDefinition documentHtmlDefinition=null) |
| Get Responsive HTML Preview for all documents in an envelope. Creates a preview of the responsive, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. More... | |
| ApiResponse< DocumentHtmlDefinitions > | CreateResponsiveHtmlPreviewWithHttpInfo (string accountId, string envelopeId, DocumentHtmlDefinition documentHtmlDefinition=null) |
| Get Responsive HTML Preview for all documents in an envelope. Creates a preview of the responsive, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. More... | |
| async System.Threading.Tasks.Task< DocumentHtmlDefinitions > | CreateResponsiveHtmlPreviewAsync (string accountId, string envelopeId, DocumentHtmlDefinition documentHtmlDefinition=null) |
| Get Responsive HTML Preview for all documents in an envelope. Creates a preview of the responsive, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitions > > | CreateResponsiveHtmlPreviewAsyncWithHttpInfo (string accountId, string envelopeId, DocumentHtmlDefinition documentHtmlDefinition=null) |
| Get Responsive HTML Preview for all documents in an envelope. Creates a preview of the responsive, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. More... | |
| ViewUrl | CreateSenderView (string accountId, string envelopeId, ReturnUrlRequest returnUrlRequest=null) |
| Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| ApiResponse< ViewUrl > | CreateSenderViewWithHttpInfo (string accountId, string envelopeId, ReturnUrlRequest returnUrlRequest=null) |
| Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| async System.Threading.Tasks.Task< ViewUrl > | CreateSenderViewAsync (string accountId, string envelopeId, ReturnUrlRequest returnUrlRequest=null) |
| Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ViewUrl > > | CreateSenderViewAsyncWithHttpInfo (string accountId, string envelopeId, ReturnUrlRequest returnUrlRequest=null) |
| Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. More... | |
| Tabs | CreateTabs (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Adds tabs for a recipient. Adds one or more tabs for a recipient. More... | |
| ApiResponse< Tabs > | CreateTabsWithHttpInfo (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Adds tabs for a recipient. Adds one or more tabs for a recipient. More... | |
| async System.Threading.Tasks.Task< Tabs > | CreateTabsAsync (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Adds tabs for a recipient. Adds one or more tabs for a recipient. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Tabs > > | CreateTabsAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Adds tabs for a recipient. Adds one or more tabs for a recipient. More... | |
| WorkflowStep | CreateTemplateWorkflowStepDefinition (string accountId, string templateId, WorkflowStep workflowStep=null) |
| Creates and adds a new workflow step definition for a template's workflow More... | |
| ApiResponse< WorkflowStep > | CreateTemplateWorkflowStepDefinitionWithHttpInfo (string accountId, string templateId, WorkflowStep workflowStep=null) |
| Creates and adds a new workflow step definition for a template's workflow More... | |
| async System.Threading.Tasks.Task< WorkflowStep > | CreateTemplateWorkflowStepDefinitionAsync (string accountId, string templateId, WorkflowStep workflowStep=null) |
| Creates and adds a new workflow step definition for a template's workflow More... | |
| async System.Threading.Tasks.Task< ApiResponse< WorkflowStep > > | CreateTemplateWorkflowStepDefinitionAsyncWithHttpInfo (string accountId, string templateId, WorkflowStep workflowStep=null) |
| Creates and adds a new workflow step definition for a template's workflow More... | |
| EnvelopeAttachmentsResult | DeleteAttachments (string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest=null) |
| Delete one or more attachments from a DRAFT envelope. Deletes one or more attachments from a draft envelope. More... | |
| ApiResponse< EnvelopeAttachmentsResult > | DeleteAttachmentsWithHttpInfo (string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest=null) |
| Delete one or more attachments from a DRAFT envelope. Deletes one or more attachments from a draft envelope. More... | |
| async System.Threading.Tasks.Task< EnvelopeAttachmentsResult > | DeleteAttachmentsAsync (string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest=null) |
| Delete one or more attachments from a DRAFT envelope. Deletes one or more attachments from a draft envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeAttachmentsResult > > | DeleteAttachmentsAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest=null) |
| Delete one or more attachments from a DRAFT envelope. Deletes one or more attachments from a draft envelope. More... | |
| ChunkedUploadResponse | DeleteChunkedUpload (string accountId, string chunkedUploadId) |
| Delete an existing ChunkedUpload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota. More... | |
| ApiResponse< ChunkedUploadResponse > | DeleteChunkedUploadWithHttpInfo (string accountId, string chunkedUploadId) |
| Delete an existing ChunkedUpload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota. More... | |
| async System.Threading.Tasks.Task< ChunkedUploadResponse > | DeleteChunkedUploadAsync (string accountId, string chunkedUploadId) |
| Delete an existing ChunkedUpload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ChunkedUploadResponse > > | DeleteChunkedUploadAsyncWithHttpInfo (string accountId, string chunkedUploadId) |
| Delete an existing ChunkedUpload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota. More... | |
| CustomFields | DeleteCustomFields (string accountId, string envelopeId, CustomFields customFields=null) |
| Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes. More... | |
| ApiResponse< CustomFields > | DeleteCustomFieldsWithHttpInfo (string accountId, string envelopeId, CustomFields customFields=null) |
| Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes. More... | |
| async System.Threading.Tasks.Task< CustomFields > | DeleteCustomFieldsAsync (string accountId, string envelopeId, CustomFields customFields=null) |
| Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes. More... | |
| async System.Threading.Tasks.Task< ApiResponse< CustomFields > > | DeleteCustomFieldsAsyncWithHttpInfo (string accountId, string envelopeId, CustomFields customFields=null) |
| Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes. More... | |
| DocumentFieldsInformation | DeleteDocumentFields (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document. More... | |
| ApiResponse< DocumentFieldsInformation > | DeleteDocumentFieldsWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document. More... | |
| async System.Threading.Tasks.Task< DocumentFieldsInformation > | DeleteDocumentFieldsAsync (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > > | DeleteDocumentFieldsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document. More... | |
| void | DeleteDocumentPage (string accountId, string envelopeId, string documentId, string pageNumber) |
| Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number. More... | |
| ApiResponse< Object > | DeleteDocumentPageWithHttpInfo (string accountId, string envelopeId, string documentId, string pageNumber) |
| Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number. More... | |
| async System.Threading.Tasks.Task | DeleteDocumentPageAsync (string accountId, string envelopeId, string documentId, string pageNumber) |
| Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteDocumentPageAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, string pageNumber) |
| Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number. More... | |
| Tabs | DeleteDocumentTabs (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| ApiResponse< Tabs > | DeleteDocumentTabsWithHttpInfo (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| async System.Threading.Tasks.Task< Tabs > | DeleteDocumentTabsAsync (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Tabs > > | DeleteDocumentTabsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| EnvelopeDocumentsResult | DeleteDocuments (string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition=null) |
| Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope. More... | |
| ApiResponse< EnvelopeDocumentsResult > | DeleteDocumentsWithHttpInfo (string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition=null) |
| Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope. More... | |
| async System.Threading.Tasks.Task< EnvelopeDocumentsResult > | DeleteDocumentsAsync (string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition=null) |
| Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeDocumentsResult > > | DeleteDocumentsAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition=null) |
| Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope. More... | |
| EmailSettings | DeleteEmailSettings (string accountId, string envelopeId) |
| Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications. More... | |
| ApiResponse< EmailSettings > | DeleteEmailSettingsWithHttpInfo (string accountId, string envelopeId) |
| Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications. More... | |
| async System.Threading.Tasks.Task< EmailSettings > | DeleteEmailSettingsAsync (string accountId, string envelopeId) |
| Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EmailSettings > > | DeleteEmailSettingsAsyncWithHttpInfo (string accountId, string envelopeId) |
| Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications. More... | |
| void | DeleteEnvelopeCorrectView (string accountId, string envelopeId, CorrectViewRequest correctViewRequest=null) |
| Revokes the correction view URL to the Envelope UI Revokes the correction view URL to the Envelope UI. More... | |
| ApiResponse< Object > | DeleteEnvelopeCorrectViewWithHttpInfo (string accountId, string envelopeId, CorrectViewRequest correctViewRequest=null) |
| Revokes the correction view URL to the Envelope UI Revokes the correction view URL to the Envelope UI. More... | |
| async System.Threading.Tasks.Task | DeleteEnvelopeCorrectViewAsync (string accountId, string envelopeId, CorrectViewRequest correctViewRequest=null) |
| Revokes the correction view URL to the Envelope UI Revokes the correction view URL to the Envelope UI. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteEnvelopeCorrectViewAsyncWithHttpInfo (string accountId, string envelopeId, CorrectViewRequest correctViewRequest=null) |
| Revokes the correction view URL to the Envelope UI Revokes the correction view URL to the Envelope UI. More... | |
| void | DeleteEnvelopeDelayedRoutingDefinition (string accountId, string envelopeId, string workflowStepId) |
| Deletes the delayed routing rules for the specified envelope workflow step. More... | |
| ApiResponse< Object > | DeleteEnvelopeDelayedRoutingDefinitionWithHttpInfo (string accountId, string envelopeId, string workflowStepId) |
| Deletes the delayed routing rules for the specified envelope workflow step. More... | |
| async System.Threading.Tasks.Task | DeleteEnvelopeDelayedRoutingDefinitionAsync (string accountId, string envelopeId, string workflowStepId) |
| Deletes the delayed routing rules for the specified envelope workflow step. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteEnvelopeDelayedRoutingDefinitionAsyncWithHttpInfo (string accountId, string envelopeId, string workflowStepId) |
| Deletes the delayed routing rules for the specified envelope workflow step. More... | |
| void | DeleteEnvelopeScheduledSendingDefinition (string accountId, string envelopeId) |
| Deletes the scheduled sending rules for the envelope's workflow. More... | |
| ApiResponse< Object > | DeleteEnvelopeScheduledSendingDefinitionWithHttpInfo (string accountId, string envelopeId) |
| Deletes the scheduled sending rules for the envelope's workflow. More... | |
| async System.Threading.Tasks.Task | DeleteEnvelopeScheduledSendingDefinitionAsync (string accountId, string envelopeId) |
| Deletes the scheduled sending rules for the envelope's workflow. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteEnvelopeScheduledSendingDefinitionAsyncWithHttpInfo (string accountId, string envelopeId) |
| Deletes the scheduled sending rules for the envelope's workflow. More... | |
| void | DeleteEnvelopeTransferRules (string accountId, string envelopeTransferRuleId) |
| Delete envelope transfer rules for an account. This method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| ApiResponse< Object > | DeleteEnvelopeTransferRulesWithHttpInfo (string accountId, string envelopeTransferRuleId) |
| Delete envelope transfer rules for an account. This method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| async System.Threading.Tasks.Task | DeleteEnvelopeTransferRulesAsync (string accountId, string envelopeTransferRuleId) |
| Delete envelope transfer rules for an account. This method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteEnvelopeTransferRulesAsyncWithHttpInfo (string accountId, string envelopeTransferRuleId) |
| Delete envelope transfer rules for an account. This method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| void | DeleteEnvelopeWorkflowDefinition (string accountId, string envelopeId) |
| Delete the workflow definition for an envelope. Deletes the specified envelope's workflow definition if it has one. More... | |
| ApiResponse< Object > | DeleteEnvelopeWorkflowDefinitionWithHttpInfo (string accountId, string envelopeId) |
| Delete the workflow definition for an envelope. Deletes the specified envelope's workflow definition if it has one. More... | |
| async System.Threading.Tasks.Task | DeleteEnvelopeWorkflowDefinitionAsync (string accountId, string envelopeId) |
| Delete the workflow definition for an envelope. Deletes the specified envelope's workflow definition if it has one. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteEnvelopeWorkflowDefinitionAsyncWithHttpInfo (string accountId, string envelopeId) |
| Delete the workflow definition for an envelope. Deletes the specified envelope's workflow definition if it has one. More... | |
| void | DeleteEnvelopeWorkflowStepDefinition (string accountId, string envelopeId, string workflowStepId) |
| Deletes the envelope workflow step definition for an envelope's workflow by step id. More... | |
| ApiResponse< Object > | DeleteEnvelopeWorkflowStepDefinitionWithHttpInfo (string accountId, string envelopeId, string workflowStepId) |
| Deletes the envelope workflow step definition for an envelope's workflow by step id. More... | |
| async System.Threading.Tasks.Task | DeleteEnvelopeWorkflowStepDefinitionAsync (string accountId, string envelopeId, string workflowStepId) |
| Deletes the envelope workflow step definition for an envelope's workflow by step id. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteEnvelopeWorkflowStepDefinitionAsyncWithHttpInfo (string accountId, string envelopeId, string workflowStepId) |
| Deletes the envelope workflow step definition for an envelope's workflow by step id. More... | |
| LockInformation | DeleteLock (string accountId, string envelopeId) |
| Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request. More... | |
| ApiResponse< LockInformation > | DeleteLockWithHttpInfo (string accountId, string envelopeId) |
| Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request. More... | |
| async System.Threading.Tasks.Task< LockInformation > | DeleteLockAsync (string accountId, string envelopeId) |
| Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request. More... | |
| async System.Threading.Tasks.Task< ApiResponse< LockInformation > > | DeleteLockAsyncWithHttpInfo (string accountId, string envelopeId) |
| Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request. More... | |
| Recipients | DeleteRecipient (string accountId, string envelopeId, string recipientId) |
| Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent. More... | |
| ApiResponse< Recipients > | DeleteRecipientWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent. More... | |
| async System.Threading.Tasks.Task< Recipients > | DeleteRecipientAsync (string accountId, string envelopeId, string recipientId) |
| Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Recipients > > | DeleteRecipientAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent. More... | |
| Recipients | DeleteRecipients (string accountId, string envelopeId, Recipients recipients=null) |
| Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted. More... | |
| ApiResponse< Recipients > | DeleteRecipientsWithHttpInfo (string accountId, string envelopeId, Recipients recipients=null) |
| Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted. More... | |
| async System.Threading.Tasks.Task< Recipients > | DeleteRecipientsAsync (string accountId, string envelopeId, Recipients recipients=null) |
| Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Recipients > > | DeleteRecipientsAsyncWithHttpInfo (string accountId, string envelopeId, Recipients recipients=null) |
| Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted. More... | |
| Tabs | DeleteTabs (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope. More... | |
| ApiResponse< Tabs > | DeleteTabsWithHttpInfo (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope. More... | |
| async System.Threading.Tasks.Task< Tabs > | DeleteTabsAsync (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Tabs > > | DeleteTabsAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope. More... | |
| void | DeleteTemplateDelayedRoutingDefinition (string accountId, string templateId, string workflowStepId) |
| Deletes the delayed routing rules for the specified template workflow step. More... | |
| ApiResponse< Object > | DeleteTemplateDelayedRoutingDefinitionWithHttpInfo (string accountId, string templateId, string workflowStepId) |
| Deletes the delayed routing rules for the specified template workflow step. More... | |
| async System.Threading.Tasks.Task | DeleteTemplateDelayedRoutingDefinitionAsync (string accountId, string templateId, string workflowStepId) |
| Deletes the delayed routing rules for the specified template workflow step. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteTemplateDelayedRoutingDefinitionAsyncWithHttpInfo (string accountId, string templateId, string workflowStepId) |
| Deletes the delayed routing rules for the specified template workflow step. More... | |
| void | DeleteTemplateScheduledSendingDefinition (string accountId, string templateId) |
| Deletes the scheduled sending rules for the template's workflow. More... | |
| ApiResponse< Object > | DeleteTemplateScheduledSendingDefinitionWithHttpInfo (string accountId, string templateId) |
| Deletes the scheduled sending rules for the template's workflow. More... | |
| async System.Threading.Tasks.Task | DeleteTemplateScheduledSendingDefinitionAsync (string accountId, string templateId) |
| Deletes the scheduled sending rules for the template's workflow. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteTemplateScheduledSendingDefinitionAsyncWithHttpInfo (string accountId, string templateId) |
| Deletes the scheduled sending rules for the template's workflow. More... | |
| void | DeleteTemplateWorkflowDefinition (string accountId, string templateId) |
| Delete the workflow definition for a template. Deletes the specified template's workflow definition if it has one. More... | |
| ApiResponse< Object > | DeleteTemplateWorkflowDefinitionWithHttpInfo (string accountId, string templateId) |
| Delete the workflow definition for a template. Deletes the specified template's workflow definition if it has one. More... | |
| async System.Threading.Tasks.Task | DeleteTemplateWorkflowDefinitionAsync (string accountId, string templateId) |
| Delete the workflow definition for a template. Deletes the specified template's workflow definition if it has one. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteTemplateWorkflowDefinitionAsyncWithHttpInfo (string accountId, string templateId) |
| Delete the workflow definition for a template. Deletes the specified template's workflow definition if it has one. More... | |
| void | DeleteTemplateWorkflowStepDefinition (string accountId, string templateId, string workflowStepId) |
| Deletes the workflow step definition for an template's workflow by step id. More... | |
| ApiResponse< Object > | DeleteTemplateWorkflowStepDefinitionWithHttpInfo (string accountId, string templateId, string workflowStepId) |
| Deletes the workflow step definition for an template's workflow by step id. More... | |
| async System.Threading.Tasks.Task | DeleteTemplateWorkflowStepDefinitionAsync (string accountId, string templateId, string workflowStepId) |
| Deletes the workflow step definition for an template's workflow by step id. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteTemplateWorkflowStepDefinitionAsyncWithHttpInfo (string accountId, string templateId, string workflowStepId) |
| Deletes the workflow step definition for an template's workflow by step id. More... | |
| void | DeleteTemplatesFromDocument (string accountId, string envelopeId, string documentId, string templateId) |
| Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope. More... | |
| ApiResponse< Object > | DeleteTemplatesFromDocumentWithHttpInfo (string accountId, string envelopeId, string documentId, string templateId) |
| Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope. More... | |
| async System.Threading.Tasks.Task | DeleteTemplatesFromDocumentAsync (string accountId, string envelopeId, string documentId, string templateId) |
| Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | DeleteTemplatesFromDocumentAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, string templateId) |
| Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope. More... | |
| void | GetAttachment (string accountId, string envelopeId, string attachmentId) |
| Retrieves an attachment from the envelope. Retrieves an attachment from an envelope. More... | |
| ApiResponse< Object > | GetAttachmentWithHttpInfo (string accountId, string envelopeId, string attachmentId) |
| Retrieves an attachment from the envelope. Retrieves an attachment from an envelope. More... | |
| async System.Threading.Tasks.Task | GetAttachmentAsync (string accountId, string envelopeId, string attachmentId) |
| Retrieves an attachment from the envelope. Retrieves an attachment from an envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | GetAttachmentAsyncWithHttpInfo (string accountId, string envelopeId, string attachmentId) |
| Retrieves an attachment from the envelope. Retrieves an attachment from an envelope. More... | |
| EnvelopeAttachmentsResult | GetAttachments (string accountId, string envelopeId) |
| Returns a list of attachments associated with the specified envelope Returns a list of attachments associated with a specified envelope More... | |
| ApiResponse< EnvelopeAttachmentsResult > | GetAttachmentsWithHttpInfo (string accountId, string envelopeId) |
| Returns a list of attachments associated with the specified envelope Returns a list of attachments associated with a specified envelope More... | |
| async System.Threading.Tasks.Task< EnvelopeAttachmentsResult > | GetAttachmentsAsync (string accountId, string envelopeId) |
| Returns a list of attachments associated with the specified envelope Returns a list of attachments associated with a specified envelope More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeAttachmentsResult > > | GetAttachmentsAsyncWithHttpInfo (string accountId, string envelopeId) |
| Returns a list of attachments associated with the specified envelope Returns a list of attachments associated with a specified envelope More... | |
| ChunkedUploadResponse | GetChunkedUpload (string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options=null) |
| Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions. More... | |
| ApiResponse< ChunkedUploadResponse > | GetChunkedUploadWithHttpInfo (string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options=null) |
| Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions. More... | |
| async System.Threading.Tasks.Task< ChunkedUploadResponse > | GetChunkedUploadAsync (string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options=null) |
| Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ChunkedUploadResponse > > | GetChunkedUploadAsyncWithHttpInfo (string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options=null) |
| Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions. More... | |
| System.IO.Stream | GetCommentsTranscript (string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options=null) |
| Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true). More... | |
| ApiResponse< System.IO.Stream > | GetCommentsTranscriptWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options=null) |
| Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true). More... | |
| async System.Threading.Tasks.Task< System.IO.Stream > | GetCommentsTranscriptAsync (string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options=null) |
| Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true). More... | |
| async System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetCommentsTranscriptAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options=null) |
| Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true). More... | |
| ConsumerDisclosure | GetConsumerDisclosure (string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options=null) |
| Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. More... | |
| ApiResponse< ConsumerDisclosure > | GetConsumerDisclosureWithHttpInfo (string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options=null) |
| Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. More... | |
| async System.Threading.Tasks.Task< ConsumerDisclosure > | GetConsumerDisclosureAsync (string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options=null) |
| Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ConsumerDisclosure > > | GetConsumerDisclosureAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options=null) |
| Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. More... | |
| ConsumerDisclosure | GetConsumerDisclosureDefault (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options=null) |
| Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure. More... | |
| ApiResponse< ConsumerDisclosure > | GetConsumerDisclosureDefaultWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options=null) |
| Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure. More... | |
| async System.Threading.Tasks.Task< ConsumerDisclosure > | GetConsumerDisclosureDefaultAsync (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options=null) |
| Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ConsumerDisclosure > > | GetConsumerDisclosureDefaultAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options=null) |
| Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure. More... | |
| System.IO.Stream | GetDocument (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options=null) |
| Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined More... | |
| ApiResponse< System.IO.Stream > | GetDocumentWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options=null) |
| Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined More... | |
| async System.Threading.Tasks.Task< System.IO.Stream > | GetDocumentAsync (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options=null) |
| Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined More... | |
| async System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetDocumentAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options=null) |
| Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined More... | |
| System.IO.Stream | GetDocumentPageImage (string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options=null) |
| Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope. More... | |
| ApiResponse< System.IO.Stream > | GetDocumentPageImageWithHttpInfo (string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options=null) |
| Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope. More... | |
| async System.Threading.Tasks.Task< System.IO.Stream > | GetDocumentPageImageAsync (string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options=null) |
| Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetDocumentPageImageAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options=null) |
| Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope. More... | |
| Tabs | GetDocumentTabs (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options=null) |
| Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| ApiResponse< Tabs > | GetDocumentTabsWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options=null) |
| Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| async System.Threading.Tasks.Task< Tabs > | GetDocumentTabsAsync (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options=null) |
| Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Tabs > > | GetDocumentTabsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options=null) |
| Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| EmailSettings | GetEmailSettings (string accountId, string envelopeId) |
| Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope. More... | |
| ApiResponse< EmailSettings > | GetEmailSettingsWithHttpInfo (string accountId, string envelopeId) |
| Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope. More... | |
| async System.Threading.Tasks.Task< EmailSettings > | GetEmailSettingsAsync (string accountId, string envelopeId) |
| Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EmailSettings > > | GetEmailSettingsAsyncWithHttpInfo (string accountId, string envelopeId) |
| Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope. More... | |
| Envelope | GetEnvelope (string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options=null) |
| Gets the status of a envelope. Retrieves the overall status for the specified envelope. More... | |
| ApiResponse< Envelope > | GetEnvelopeWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options=null) |
| Gets the status of a envelope. Retrieves the overall status for the specified envelope. More... | |
| async System.Threading.Tasks.Task< Envelope > | GetEnvelopeAsync (string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options=null) |
| Gets the status of a envelope. Retrieves the overall status for the specified envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Envelope > > | GetEnvelopeAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options=null) |
| Gets the status of a envelope. Retrieves the overall status for the specified envelope. More... | |
| DelayedRouting | GetEnvelopeDelayedRoutingDefinition (string accountId, string envelopeId, string workflowStepId) |
| Returns the delayed routing rules for an envelope's workflow step definition. More... | |
| ApiResponse< DelayedRouting > | GetEnvelopeDelayedRoutingDefinitionWithHttpInfo (string accountId, string envelopeId, string workflowStepId) |
| Returns the delayed routing rules for an envelope's workflow step definition. More... | |
| async System.Threading.Tasks.Task< DelayedRouting > | GetEnvelopeDelayedRoutingDefinitionAsync (string accountId, string envelopeId, string workflowStepId) |
| Returns the delayed routing rules for an envelope's workflow step definition. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DelayedRouting > > | GetEnvelopeDelayedRoutingDefinitionAsyncWithHttpInfo (string accountId, string envelopeId, string workflowStepId) |
| Returns the delayed routing rules for an envelope's workflow step definition. More... | |
| DocGenFormFieldResponse | GetEnvelopeDocGenFormFields (string accountId, string envelopeId) |
| Returns formfields for an envelope More... | |
| ApiResponse< DocGenFormFieldResponse > | GetEnvelopeDocGenFormFieldsWithHttpInfo (string accountId, string envelopeId) |
| Returns formfields for an envelope More... | |
| async System.Threading.Tasks.Task< DocGenFormFieldResponse > | GetEnvelopeDocGenFormFieldsAsync (string accountId, string envelopeId) |
| Returns formfields for an envelope More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocGenFormFieldResponse > > | GetEnvelopeDocGenFormFieldsAsyncWithHttpInfo (string accountId, string envelopeId) |
| Returns formfields for an envelope More... | |
| DocumentHtmlDefinitionOriginals | GetEnvelopeDocumentHtmlDefinitions (string accountId, string envelopeId, string documentId) |
| Get the Original HTML Definition used to generate the Responsive HTML for a given document. More... | |
| ApiResponse< DocumentHtmlDefinitionOriginals > | GetEnvelopeDocumentHtmlDefinitionsWithHttpInfo (string accountId, string envelopeId, string documentId) |
| Get the Original HTML Definition used to generate the Responsive HTML for a given document. More... | |
| async System.Threading.Tasks.Task< DocumentHtmlDefinitionOriginals > | GetEnvelopeDocumentHtmlDefinitionsAsync (string accountId, string envelopeId, string documentId) |
| Get the Original HTML Definition used to generate the Responsive HTML for a given document. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitionOriginals > > | GetEnvelopeDocumentHtmlDefinitionsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId) |
| Get the Original HTML Definition used to generate the Responsive HTML for a given document. More... | |
| DocumentHtmlDefinitionOriginals | GetEnvelopeHtmlDefinitions (string accountId, string envelopeId) |
| Get the Original HTML Definition used to generate the Responsive HTML for the envelope. More... | |
| ApiResponse< DocumentHtmlDefinitionOriginals > | GetEnvelopeHtmlDefinitionsWithHttpInfo (string accountId, string envelopeId) |
| Get the Original HTML Definition used to generate the Responsive HTML for the envelope. More... | |
| async System.Threading.Tasks.Task< DocumentHtmlDefinitionOriginals > | GetEnvelopeHtmlDefinitionsAsync (string accountId, string envelopeId) |
| Get the Original HTML Definition used to generate the Responsive HTML for the envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentHtmlDefinitionOriginals > > | GetEnvelopeHtmlDefinitionsAsyncWithHttpInfo (string accountId, string envelopeId) |
| Get the Original HTML Definition used to generate the Responsive HTML for the envelope. More... | |
| ScheduledSending | GetEnvelopeScheduledSendingDefinition (string accountId, string envelopeId) |
| Returns the scheduled sending rules for an envelope's workflow definition. More... | |
| ApiResponse< ScheduledSending > | GetEnvelopeScheduledSendingDefinitionWithHttpInfo (string accountId, string envelopeId) |
| Returns the scheduled sending rules for an envelope's workflow definition. More... | |
| async System.Threading.Tasks.Task< ScheduledSending > | GetEnvelopeScheduledSendingDefinitionAsync (string accountId, string envelopeId) |
| Returns the scheduled sending rules for an envelope's workflow definition. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ScheduledSending > > | GetEnvelopeScheduledSendingDefinitionAsyncWithHttpInfo (string accountId, string envelopeId) |
| Returns the scheduled sending rules for an envelope's workflow definition. More... | |
| EnvelopeTransferRuleInformation | GetEnvelopeTransferRules (string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options=null) |
| Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| ApiResponse< EnvelopeTransferRuleInformation > | GetEnvelopeTransferRulesWithHttpInfo (string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options=null) |
| Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| async System.Threading.Tasks.Task< EnvelopeTransferRuleInformation > | GetEnvelopeTransferRulesAsync (string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options=null) |
| Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeTransferRuleInformation > > | GetEnvelopeTransferRulesAsyncWithHttpInfo (string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options=null) |
| Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| Workflow | GetEnvelopeWorkflowDefinition (string accountId, string envelopeId) |
| Returns the workflow definition for an envelope. Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one. More... | |
| ApiResponse< Workflow > | GetEnvelopeWorkflowDefinitionWithHttpInfo (string accountId, string envelopeId) |
| Returns the workflow definition for an envelope. Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one. More... | |
| async System.Threading.Tasks.Task< Workflow > | GetEnvelopeWorkflowDefinitionAsync (string accountId, string envelopeId) |
| Returns the workflow definition for an envelope. Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Workflow > > | GetEnvelopeWorkflowDefinitionAsyncWithHttpInfo (string accountId, string envelopeId) |
| Returns the workflow definition for an envelope. Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one. More... | |
| WorkflowStep | GetEnvelopeWorkflowStepDefinition (string accountId, string envelopeId, string workflowStepId) |
| Returns the workflow step definition for an envelope by step id. More... | |
| ApiResponse< WorkflowStep > | GetEnvelopeWorkflowStepDefinitionWithHttpInfo (string accountId, string envelopeId, string workflowStepId) |
| Returns the workflow step definition for an envelope by step id. More... | |
| async System.Threading.Tasks.Task< WorkflowStep > | GetEnvelopeWorkflowStepDefinitionAsync (string accountId, string envelopeId, string workflowStepId) |
| Returns the workflow step definition for an envelope by step id. More... | |
| async System.Threading.Tasks.Task< ApiResponse< WorkflowStep > > | GetEnvelopeWorkflowStepDefinitionAsyncWithHttpInfo (string accountId, string envelopeId, string workflowStepId) |
| Returns the workflow step definition for an envelope by step id. More... | |
| EnvelopeFormData | GetFormData (string accountId, string envelopeId) |
| Returns envelope form data for an existing envelope. This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account. ### Related topics - How to get envelope tab values More... | |
| ApiResponse< EnvelopeFormData > | GetFormDataWithHttpInfo (string accountId, string envelopeId) |
| Returns envelope form data for an existing envelope. This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account. ### Related topics - How to get envelope tab values More... | |
| async System.Threading.Tasks.Task< EnvelopeFormData > | GetFormDataAsync (string accountId, string envelopeId) |
| Returns envelope form data for an existing envelope. This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account. ### Related topics - How to get envelope tab values More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeFormData > > | GetFormDataAsyncWithHttpInfo (string accountId, string envelopeId) |
| Returns envelope form data for an existing envelope. This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account. ### Related topics - How to get envelope tab values More... | |
| LockInformation | GetLock (string accountId, string envelopeId) |
| Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header. More... | |
| ApiResponse< LockInformation > | GetLockWithHttpInfo (string accountId, string envelopeId) |
| Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header. More... | |
| async System.Threading.Tasks.Task< LockInformation > | GetLockAsync (string accountId, string envelopeId) |
| Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header. More... | |
| async System.Threading.Tasks.Task< ApiResponse< LockInformation > > | GetLockAsyncWithHttpInfo (string accountId, string envelopeId) |
| Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header. More... | |
| Notification | GetNotificationSettings (string accountId, string envelopeId) |
| Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope. More... | |
| ApiResponse< Notification > | GetNotificationSettingsWithHttpInfo (string accountId, string envelopeId) |
| Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope. More... | |
| async System.Threading.Tasks.Task< Notification > | GetNotificationSettingsAsync (string accountId, string envelopeId) |
| Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Notification > > | GetNotificationSettingsAsyncWithHttpInfo (string accountId, string envelopeId) |
| Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope. More... | |
| Tabs | GetPageTabs (string accountId, string envelopeId, string documentId, string pageNumber) |
| Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| ApiResponse< Tabs > | GetPageTabsWithHttpInfo (string accountId, string envelopeId, string documentId, string pageNumber) |
| Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| async System.Threading.Tasks.Task< Tabs > | GetPageTabsAsync (string accountId, string envelopeId, string documentId, string pageNumber) |
| Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Tabs > > | GetPageTabsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, string pageNumber) |
| Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| PageImages | GetPages (string accountId, string envelopeId, string documentId, EnvelopesApi.GetPagesOptions options=null) |
| Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify. More... | |
| ApiResponse< PageImages > | GetPagesWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetPagesOptions options=null) |
| Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify. More... | |
| async System.Threading.Tasks.Task< PageImages > | GetPagesAsync (string accountId, string envelopeId, string documentId, EnvelopesApi.GetPagesOptions options=null) |
| Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify. More... | |
| async System.Threading.Tasks.Task< ApiResponse< PageImages > > | GetPagesAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetPagesOptions options=null) |
| Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify. More... | |
| DocumentVisibilityList | GetRecipientDocumentVisibility (string accountId, string envelopeId, string recipientId) |
| Returns document visibility for the recipients This method returns information about document visibility for a recipient. More... | |
| ApiResponse< DocumentVisibilityList > | GetRecipientDocumentVisibilityWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Returns document visibility for the recipients This method returns information about document visibility for a recipient. More... | |
| async System.Threading.Tasks.Task< DocumentVisibilityList > | GetRecipientDocumentVisibilityAsync (string accountId, string envelopeId, string recipientId) |
| Returns document visibility for the recipients This method returns information about document visibility for a recipient. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentVisibilityList > > | GetRecipientDocumentVisibilityAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Returns document visibility for the recipients This method returns information about document visibility for a recipient. More... | |
| System.IO.Stream | GetRecipientInitialsImage (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientInitialsImageOptions options=null) |
| Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image. More... | |
| ApiResponse< System.IO.Stream > | GetRecipientInitialsImageWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientInitialsImageOptions options=null) |
| Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image. More... | |
| async System.Threading.Tasks.Task< System.IO.Stream > | GetRecipientInitialsImageAsync (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientInitialsImageOptions options=null) |
| Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image. More... | |
| async System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetRecipientInitialsImageAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientInitialsImageOptions options=null) |
| Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image. More... | |
| UserSignature | GetRecipientSignature (string accountId, string envelopeId, string recipientId) |
| Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient. More... | |
| ApiResponse< UserSignature > | GetRecipientSignatureWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient. More... | |
| async System.Threading.Tasks.Task< UserSignature > | GetRecipientSignatureAsync (string accountId, string envelopeId, string recipientId) |
| Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient. More... | |
| async System.Threading.Tasks.Task< ApiResponse< UserSignature > > | GetRecipientSignatureAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient. More... | |
| System.IO.Stream | GetRecipientSignatureImage (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientSignatureImageOptions options=null) |
| Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. More... | |
| ApiResponse< System.IO.Stream > | GetRecipientSignatureImageWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientSignatureImageOptions options=null) |
| Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. More... | |
| async System.Threading.Tasks.Task< System.IO.Stream > | GetRecipientSignatureImageAsync (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientSignatureImageOptions options=null) |
| Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. More... | |
| async System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetRecipientSignatureImageAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientSignatureImageOptions options=null) |
| Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. More... | |
| void | GetTabsBlob (string accountId, string envelopeId) |
| Get encrypted tabs for envelope. More... | |
| ApiResponse< Object > | GetTabsBlobWithHttpInfo (string accountId, string envelopeId) |
| Get encrypted tabs for envelope. More... | |
| async System.Threading.Tasks.Task | GetTabsBlobAsync (string accountId, string envelopeId) |
| Get encrypted tabs for envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | GetTabsBlobAsyncWithHttpInfo (string accountId, string envelopeId) |
| Get encrypted tabs for envelope. More... | |
| DelayedRouting | GetTemplateDelayedRoutingDefinition (string accountId, string templateId, string workflowStepId) |
| Returns the delayed routing rules for a template's workflow step definition. More... | |
| ApiResponse< DelayedRouting > | GetTemplateDelayedRoutingDefinitionWithHttpInfo (string accountId, string templateId, string workflowStepId) |
| Returns the delayed routing rules for a template's workflow step definition. More... | |
| async System.Threading.Tasks.Task< DelayedRouting > | GetTemplateDelayedRoutingDefinitionAsync (string accountId, string templateId, string workflowStepId) |
| Returns the delayed routing rules for a template's workflow step definition. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DelayedRouting > > | GetTemplateDelayedRoutingDefinitionAsyncWithHttpInfo (string accountId, string templateId, string workflowStepId) |
| Returns the delayed routing rules for a template's workflow step definition. More... | |
| DocumentVisibilityList | GetTemplateRecipientDocumentVisibility (string accountId, string templateId, string recipientId) |
| Returns document visibility for the recipients This method returns information about document visibility for a template recipient. More... | |
| ApiResponse< DocumentVisibilityList > | GetTemplateRecipientDocumentVisibilityWithHttpInfo (string accountId, string templateId, string recipientId) |
| Returns document visibility for the recipients This method returns information about document visibility for a template recipient. More... | |
| async System.Threading.Tasks.Task< DocumentVisibilityList > | GetTemplateRecipientDocumentVisibilityAsync (string accountId, string templateId, string recipientId) |
| Returns document visibility for the recipients This method returns information about document visibility for a template recipient. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentVisibilityList > > | GetTemplateRecipientDocumentVisibilityAsyncWithHttpInfo (string accountId, string templateId, string recipientId) |
| Returns document visibility for the recipients This method returns information about document visibility for a template recipient. More... | |
| ScheduledSending | GetTemplateScheduledSendingDefinition (string accountId, string templateId) |
| Returns the scheduled sending rules for a template's workflow definition. More... | |
| ApiResponse< ScheduledSending > | GetTemplateScheduledSendingDefinitionWithHttpInfo (string accountId, string templateId) |
| Returns the scheduled sending rules for a template's workflow definition. More... | |
| async System.Threading.Tasks.Task< ScheduledSending > | GetTemplateScheduledSendingDefinitionAsync (string accountId, string templateId) |
| Returns the scheduled sending rules for a template's workflow definition. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ScheduledSending > > | GetTemplateScheduledSendingDefinitionAsyncWithHttpInfo (string accountId, string templateId) |
| Returns the scheduled sending rules for a template's workflow definition. More... | |
| Workflow | GetTemplateWorkflowDefinition (string accountId, string templateId) |
| Returns the workflow definition for a template. Returns template's workflow definition if the template specified by `templateId` has one. More... | |
| ApiResponse< Workflow > | GetTemplateWorkflowDefinitionWithHttpInfo (string accountId, string templateId) |
| Returns the workflow definition for a template. Returns template's workflow definition if the template specified by `templateId` has one. More... | |
| async System.Threading.Tasks.Task< Workflow > | GetTemplateWorkflowDefinitionAsync (string accountId, string templateId) |
| Returns the workflow definition for a template. Returns template's workflow definition if the template specified by `templateId` has one. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Workflow > > | GetTemplateWorkflowDefinitionAsyncWithHttpInfo (string accountId, string templateId) |
| Returns the workflow definition for a template. Returns template's workflow definition if the template specified by `templateId` has one. More... | |
| WorkflowStep | GetTemplateWorkflowStepDefinition (string accountId, string templateId, string workflowStepId) |
| Returns the workflow step definition for a template by step id. More... | |
| ApiResponse< WorkflowStep > | GetTemplateWorkflowStepDefinitionWithHttpInfo (string accountId, string templateId, string workflowStepId) |
| Returns the workflow step definition for a template by step id. More... | |
| async System.Threading.Tasks.Task< WorkflowStep > | GetTemplateWorkflowStepDefinitionAsync (string accountId, string templateId, string workflowStepId) |
| Returns the workflow step definition for a template by step id. More... | |
| async System.Threading.Tasks.Task< ApiResponse< WorkflowStep > > | GetTemplateWorkflowStepDefinitionAsyncWithHttpInfo (string accountId, string templateId, string workflowStepId) |
| Returns the workflow step definition for a template by step id. More... | |
| EnvelopeAuditEventResponse | ListAuditEvents (string accountId, string envelopeId) |
| Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope. More... | |
| ApiResponse< EnvelopeAuditEventResponse > | ListAuditEventsWithHttpInfo (string accountId, string envelopeId) |
| Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope. More... | |
| async System.Threading.Tasks.Task< EnvelopeAuditEventResponse > | ListAuditEventsAsync (string accountId, string envelopeId) |
| Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeAuditEventResponse > > | ListAuditEventsAsyncWithHttpInfo (string accountId, string envelopeId) |
| Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope. More... | |
| CustomFieldsEnvelope | ListCustomFields (string accountId, string envelopeId) |
| Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. More... | |
| ApiResponse< CustomFieldsEnvelope > | ListCustomFieldsWithHttpInfo (string accountId, string envelopeId) |
| Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. More... | |
| async System.Threading.Tasks.Task< CustomFieldsEnvelope > | ListCustomFieldsAsync (string accountId, string envelopeId) |
| Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. More... | |
| async System.Threading.Tasks.Task< ApiResponse< CustomFieldsEnvelope > > | ListCustomFieldsAsyncWithHttpInfo (string accountId, string envelopeId) |
| Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list. More... | |
| DocumentFieldsInformation | ListDocumentFields (string accountId, string envelopeId, string documentId) |
| Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document. More... | |
| ApiResponse< DocumentFieldsInformation > | ListDocumentFieldsWithHttpInfo (string accountId, string envelopeId, string documentId) |
| Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document. More... | |
| async System.Threading.Tasks.Task< DocumentFieldsInformation > | ListDocumentFieldsAsync (string accountId, string envelopeId, string documentId) |
| Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > > | ListDocumentFieldsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId) |
| Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document. More... | |
| EnvelopeDocumentsResult | ListDocuments (string accountId, string envelopeId, EnvelopesApi.ListDocumentsOptions options=null) |
| Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope. More... | |
| ApiResponse< EnvelopeDocumentsResult > | ListDocumentsWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListDocumentsOptions options=null) |
| Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope. More... | |
| async System.Threading.Tasks.Task< EnvelopeDocumentsResult > | ListDocumentsAsync (string accountId, string envelopeId, EnvelopesApi.ListDocumentsOptions options=null) |
| Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeDocumentsResult > > | ListDocumentsAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListDocumentsOptions options=null) |
| Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope. More... | |
| Recipients | ListRecipients (string accountId, string envelopeId, EnvelopesApi.ListRecipientsOptions options=null) |
| Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. More... | |
| ApiResponse< Recipients > | ListRecipientsWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListRecipientsOptions options=null) |
| Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. More... | |
| async System.Threading.Tasks.Task< Recipients > | ListRecipientsAsync (string accountId, string envelopeId, EnvelopesApi.ListRecipientsOptions options=null) |
| Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Recipients > > | ListRecipientsAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListRecipientsOptions options=null) |
| Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions. More... | |
| EnvelopesInformation | ListStatus (string accountId, EnvelopeIdsRequest envelopeIdsRequest=null, EnvelopesApi.ListStatusOptions options=null) |
| Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes. More... | |
| ApiResponse< EnvelopesInformation > | ListStatusWithHttpInfo (string accountId, EnvelopeIdsRequest envelopeIdsRequest=null, EnvelopesApi.ListStatusOptions options=null) |
| Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes. More... | |
| async System.Threading.Tasks.Task< EnvelopesInformation > | ListStatusAsync (string accountId, EnvelopeIdsRequest envelopeIdsRequest=null, EnvelopesApi.ListStatusOptions options=null) |
| Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopesInformation > > | ListStatusAsyncWithHttpInfo (string accountId, EnvelopeIdsRequest envelopeIdsRequest=null, EnvelopesApi.ListStatusOptions options=null) |
| Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes. More... | |
| EnvelopesInformation | ListStatusChanges (string accountId, EnvelopesApi.ListStatusChangesOptions options=null) |
| Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. More... | |
| ApiResponse< EnvelopesInformation > | ListStatusChangesWithHttpInfo (string accountId, EnvelopesApi.ListStatusChangesOptions options=null) |
| Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. More... | |
| async System.Threading.Tasks.Task< EnvelopesInformation > | ListStatusChangesAsync (string accountId, EnvelopesApi.ListStatusChangesOptions options=null) |
| Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopesInformation > > | ListStatusChangesAsyncWithHttpInfo (string accountId, EnvelopesApi.ListStatusChangesOptions options=null) |
| Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier. More... | |
| Tabs | ListTabs (string accountId, string envelopeId, string recipientId, EnvelopesApi.ListTabsOptions options=null) |
| Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope. More... | |
| ApiResponse< Tabs > | ListTabsWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.ListTabsOptions options=null) |
| Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope. More... | |
| async System.Threading.Tasks.Task< Tabs > | ListTabsAsync (string accountId, string envelopeId, string recipientId, EnvelopesApi.ListTabsOptions options=null) |
| Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Tabs > > | ListTabsAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.ListTabsOptions options=null) |
| Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope. More... | |
| TemplateInformation | ListTemplates (string accountId, string envelopeId, EnvelopesApi.ListTemplatesOptions options=null) |
| Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope. More... | |
| ApiResponse< TemplateInformation > | ListTemplatesWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListTemplatesOptions options=null) |
| Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope. More... | |
| async System.Threading.Tasks.Task< TemplateInformation > | ListTemplatesAsync (string accountId, string envelopeId, EnvelopesApi.ListTemplatesOptions options=null) |
| Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< TemplateInformation > > | ListTemplatesAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListTemplatesOptions options=null) |
| Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope. More... | |
| TemplateInformation | ListTemplatesForDocument (string accountId, string envelopeId, string documentId, EnvelopesApi.ListTemplatesForDocumentOptions options=null) |
| Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope. More... | |
| ApiResponse< TemplateInformation > | ListTemplatesForDocumentWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.ListTemplatesForDocumentOptions options=null) |
| Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope. More... | |
| async System.Threading.Tasks.Task< TemplateInformation > | ListTemplatesForDocumentAsync (string accountId, string envelopeId, string documentId, EnvelopesApi.ListTemplatesForDocumentOptions options=null) |
| Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< TemplateInformation > > | ListTemplatesForDocumentAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.ListTemplatesForDocumentOptions options=null) |
| Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope. More... | |
| EnvelopeAttachmentsResult | PutAttachment (string accountId, string envelopeId, string attachmentId, Attachment attachment=null) |
| Add an attachment to a DRAFT or IN-PROCESS envelope. Adds an attachment to a draft or in-process envelope. More... | |
| ApiResponse< EnvelopeAttachmentsResult > | PutAttachmentWithHttpInfo (string accountId, string envelopeId, string attachmentId, Attachment attachment=null) |
| Add an attachment to a DRAFT or IN-PROCESS envelope. Adds an attachment to a draft or in-process envelope. More... | |
| async System.Threading.Tasks.Task< EnvelopeAttachmentsResult > | PutAttachmentAsync (string accountId, string envelopeId, string attachmentId, Attachment attachment=null) |
| Add an attachment to a DRAFT or IN-PROCESS envelope. Adds an attachment to a draft or in-process envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeAttachmentsResult > > | PutAttachmentAsyncWithHttpInfo (string accountId, string envelopeId, string attachmentId, Attachment attachment=null) |
| Add an attachment to a DRAFT or IN-PROCESS envelope. Adds an attachment to a draft or in-process envelope. More... | |
| EnvelopeAttachmentsResult | PutAttachments (string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest=null) |
| Add one or more attachments to a DRAFT or IN-PROCESS envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see Supported File Formats. More... | |
| ApiResponse< EnvelopeAttachmentsResult > | PutAttachmentsWithHttpInfo (string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest=null) |
| Add one or more attachments to a DRAFT or IN-PROCESS envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see Supported File Formats. More... | |
| async System.Threading.Tasks.Task< EnvelopeAttachmentsResult > | PutAttachmentsAsync (string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest=null) |
| Add one or more attachments to a DRAFT or IN-PROCESS envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see Supported File Formats. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeAttachmentsResult > > | PutAttachmentsAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopeAttachmentsRequest envelopeAttachmentsRequest=null) |
| Add one or more attachments to a DRAFT or IN-PROCESS envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see Supported File Formats. More... | |
| void | RotateDocumentPage (string accountId, string envelopeId, string documentId, string pageNumber, PageRequest pageRequest=null) |
| Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right. More... | |
| ApiResponse< Object > | RotateDocumentPageWithHttpInfo (string accountId, string envelopeId, string documentId, string pageNumber, PageRequest pageRequest=null) |
| Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right. More... | |
| async System.Threading.Tasks.Task | RotateDocumentPageAsync (string accountId, string envelopeId, string documentId, string pageNumber, PageRequest pageRequest=null) |
| Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | RotateDocumentPageAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, string pageNumber, PageRequest pageRequest=null) |
| Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right. More... | |
| EnvelopeUpdateSummary | Update (string accountId, string envelopeId, Envelope envelope=null, EnvelopesApi.UpdateOptions options=null) |
| Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {"status":"sent"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {"purgeState":"purge type"} to the request body. Additional information on purging documents The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted. More... | |
| ApiResponse< EnvelopeUpdateSummary > | UpdateWithHttpInfo (string accountId, string envelopeId, Envelope envelope=null, EnvelopesApi.UpdateOptions options=null) |
| Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {"status":"sent"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {"purgeState":"purge type"} to the request body. Additional information on purging documents The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted. More... | |
| async System.Threading.Tasks.Task< EnvelopeUpdateSummary > | UpdateAsync (string accountId, string envelopeId, Envelope envelope=null, EnvelopesApi.UpdateOptions options=null) |
| Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {"status":"sent"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {"purgeState":"purge type"} to the request body. Additional information on purging documents The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeUpdateSummary > > | UpdateAsyncWithHttpInfo (string accountId, string envelopeId, Envelope envelope=null, EnvelopesApi.UpdateOptions options=null) |
| Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {"status":"sent"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {"purgeState":"purge type"} to the request body. Additional information on purging documents The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted. More... | |
| ChunkedUploadResponse | UpdateChunkedUpload (string accountId, string chunkedUploadId, EnvelopesApi.UpdateChunkedUploadOptions options=null) |
| Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts. More... | |
| ApiResponse< ChunkedUploadResponse > | UpdateChunkedUploadWithHttpInfo (string accountId, string chunkedUploadId, EnvelopesApi.UpdateChunkedUploadOptions options=null) |
| Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts. More... | |
| async System.Threading.Tasks.Task< ChunkedUploadResponse > | UpdateChunkedUploadAsync (string accountId, string chunkedUploadId, EnvelopesApi.UpdateChunkedUploadOptions options=null) |
| Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ChunkedUploadResponse > > | UpdateChunkedUploadAsyncWithHttpInfo (string accountId, string chunkedUploadId, EnvelopesApi.UpdateChunkedUploadOptions options=null) |
| Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts. More... | |
| ChunkedUploadResponse | UpdateChunkedUploadPart (string accountId, string chunkedUploadId, string chunkedUploadPartSeq, ChunkedUploadRequest chunkedUploadRequest=null) |
| Add a chunk, a chunk 'part', to an existing ChunkedUpload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed. More... | |
| ApiResponse< ChunkedUploadResponse > | UpdateChunkedUploadPartWithHttpInfo (string accountId, string chunkedUploadId, string chunkedUploadPartSeq, ChunkedUploadRequest chunkedUploadRequest=null) |
| Add a chunk, a chunk 'part', to an existing ChunkedUpload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed. More... | |
| async System.Threading.Tasks.Task< ChunkedUploadResponse > | UpdateChunkedUploadPartAsync (string accountId, string chunkedUploadId, string chunkedUploadPartSeq, ChunkedUploadRequest chunkedUploadRequest=null) |
| Add a chunk, a chunk 'part', to an existing ChunkedUpload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ChunkedUploadResponse > > | UpdateChunkedUploadPartAsyncWithHttpInfo (string accountId, string chunkedUploadId, string chunkedUploadPartSeq, ChunkedUploadRequest chunkedUploadRequest=null) |
| Add a chunk, a chunk 'part', to an existing ChunkedUpload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed. More... | |
| CustomFields | UpdateCustomFields (string accountId, string envelopeId, CustomFields customFields=null) |
| Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name. More... | |
| ApiResponse< CustomFields > | UpdateCustomFieldsWithHttpInfo (string accountId, string envelopeId, CustomFields customFields=null) |
| Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name. More... | |
| async System.Threading.Tasks.Task< CustomFields > | UpdateCustomFieldsAsync (string accountId, string envelopeId, CustomFields customFields=null) |
| Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name. More... | |
| async System.Threading.Tasks.Task< ApiResponse< CustomFields > > | UpdateCustomFieldsAsyncWithHttpInfo (string accountId, string envelopeId, CustomFields customFields=null) |
| Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name. More... | |
| EnvelopeDocument | UpdateDocument (string accountId, string envelopeId, string documentId, byte[] documentFileBytes) |
| Adds a document to an existing draft envelope. Adds a document to an existing draft envelope. More... | |
| ApiResponse< EnvelopeDocument > | UpdateDocumentWithHttpInfo (string accountId, string envelopeId, string documentId, byte[] documentFileBytes) |
| Adds a document to an existing draft envelope. Adds a document to an existing draft envelope. More... | |
| async System.Threading.Tasks.Task< EnvelopeDocument > | UpdateDocumentAsync (string accountId, string envelopeId, string documentId, byte[] documentFileBytes) |
| Adds a document to an existing draft envelope. Adds a document to an existing draft envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeDocument > > | UpdateDocumentAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, byte[] documentFileBytes) |
| Adds a document to an existing draft envelope. Adds a document to an existing draft envelope. More... | |
| DocumentFieldsInformation | UpdateDocumentFields (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document. More... | |
| ApiResponse< DocumentFieldsInformation > | UpdateDocumentFieldsWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document. More... | |
| async System.Threading.Tasks.Task< DocumentFieldsInformation > | UpdateDocumentFieldsAsync (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentFieldsInformation > > | UpdateDocumentFieldsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentFieldsInformation documentFieldsInformation=null) |
| Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document. More... | |
| Tabs | UpdateDocumentTabs (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Updates the tabs for an envelope document Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| ApiResponse< Tabs > | UpdateDocumentTabsWithHttpInfo (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Updates the tabs for an envelope document Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| async System.Threading.Tasks.Task< Tabs > | UpdateDocumentTabsAsync (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Updates the tabs for an envelope document Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Tabs > > | UpdateDocumentTabsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, Tabs tabs=null) |
| Updates the tabs for an envelope document Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`. More... | |
| EnvelopeDocumentsResult | UpdateDocuments (string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition=null) |
| Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document. More... | |
| ApiResponse< EnvelopeDocumentsResult > | UpdateDocumentsWithHttpInfo (string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition=null) |
| Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document. More... | |
| async System.Threading.Tasks.Task< EnvelopeDocumentsResult > | UpdateDocumentsAsync (string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition=null) |
| Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeDocumentsResult > > | UpdateDocumentsAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopeDefinition envelopeDefinition=null) |
| Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document. More... | |
| EmailSettings | UpdateEmailSettings (string accountId, string envelopeId, EmailSettings emailSettings=null) |
| Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted. More... | |
| ApiResponse< EmailSettings > | UpdateEmailSettingsWithHttpInfo (string accountId, string envelopeId, EmailSettings emailSettings=null) |
| Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted. More... | |
| async System.Threading.Tasks.Task< EmailSettings > | UpdateEmailSettingsAsync (string accountId, string envelopeId, EmailSettings emailSettings=null) |
| Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EmailSettings > > | UpdateEmailSettingsAsyncWithHttpInfo (string accountId, string envelopeId, EmailSettings emailSettings=null) |
| Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted. More... | |
| DelayedRouting | UpdateEnvelopeDelayedRoutingDefinition (string accountId, string envelopeId, string workflowStepId, DelayedRouting delayedRouting=null) |
| Updates the delayed routing rules for an envelope's workflow step definition. More... | |
| ApiResponse< DelayedRouting > | UpdateEnvelopeDelayedRoutingDefinitionWithHttpInfo (string accountId, string envelopeId, string workflowStepId, DelayedRouting delayedRouting=null) |
| Updates the delayed routing rules for an envelope's workflow step definition. More... | |
| async System.Threading.Tasks.Task< DelayedRouting > | UpdateEnvelopeDelayedRoutingDefinitionAsync (string accountId, string envelopeId, string workflowStepId, DelayedRouting delayedRouting=null) |
| Updates the delayed routing rules for an envelope's workflow step definition. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DelayedRouting > > | UpdateEnvelopeDelayedRoutingDefinitionAsyncWithHttpInfo (string accountId, string envelopeId, string workflowStepId, DelayedRouting delayedRouting=null) |
| Updates the delayed routing rules for an envelope's workflow step definition. More... | |
| DocGenFormFieldResponse | UpdateEnvelopeDocGenFormFields (string accountId, string envelopeId, DocGenFormFieldRequest docGenFormFieldRequest=null, EnvelopesApi.UpdateEnvelopeDocGenFormFieldsOptions options=null) |
| Updates formfields for an envelope More... | |
| ApiResponse< DocGenFormFieldResponse > | UpdateEnvelopeDocGenFormFieldsWithHttpInfo (string accountId, string envelopeId, DocGenFormFieldRequest docGenFormFieldRequest=null, EnvelopesApi.UpdateEnvelopeDocGenFormFieldsOptions options=null) |
| Updates formfields for an envelope More... | |
| async System.Threading.Tasks.Task< DocGenFormFieldResponse > | UpdateEnvelopeDocGenFormFieldsAsync (string accountId, string envelopeId, DocGenFormFieldRequest docGenFormFieldRequest=null, EnvelopesApi.UpdateEnvelopeDocGenFormFieldsOptions options=null) |
| Updates formfields for an envelope More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocGenFormFieldResponse > > | UpdateEnvelopeDocGenFormFieldsAsyncWithHttpInfo (string accountId, string envelopeId, DocGenFormFieldRequest docGenFormFieldRequest=null, EnvelopesApi.UpdateEnvelopeDocGenFormFieldsOptions options=null) |
| Updates formfields for an envelope More... | |
| ScheduledSending | UpdateEnvelopeScheduledSendingDefinition (string accountId, string envelopeId, ScheduledSending scheduledSending=null) |
| Updates the scheduled sending rules for an envelope's workflow definition. More... | |
| ApiResponse< ScheduledSending > | UpdateEnvelopeScheduledSendingDefinitionWithHttpInfo (string accountId, string envelopeId, ScheduledSending scheduledSending=null) |
| Updates the scheduled sending rules for an envelope's workflow definition. More... | |
| async System.Threading.Tasks.Task< ScheduledSending > | UpdateEnvelopeScheduledSendingDefinitionAsync (string accountId, string envelopeId, ScheduledSending scheduledSending=null) |
| Updates the scheduled sending rules for an envelope's workflow definition. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ScheduledSending > > | UpdateEnvelopeScheduledSendingDefinitionAsyncWithHttpInfo (string accountId, string envelopeId, ScheduledSending scheduledSending=null) |
| Updates the scheduled sending rules for an envelope's workflow definition. More... | |
| EnvelopeTransferRule | UpdateEnvelopeTransferRule (string accountId, string envelopeTransferRuleId, EnvelopeTransferRule envelopeTransferRule=null) |
| Update an envelope transfer rule for an account. This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| ApiResponse< EnvelopeTransferRule > | UpdateEnvelopeTransferRuleWithHttpInfo (string accountId, string envelopeTransferRuleId, EnvelopeTransferRule envelopeTransferRule=null) |
| Update an envelope transfer rule for an account. This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| async System.Threading.Tasks.Task< EnvelopeTransferRule > | UpdateEnvelopeTransferRuleAsync (string accountId, string envelopeTransferRuleId, EnvelopeTransferRule envelopeTransferRule=null) |
| Update an envelope transfer rule for an account. This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeTransferRule > > | UpdateEnvelopeTransferRuleAsyncWithHttpInfo (string accountId, string envelopeTransferRuleId, EnvelopeTransferRule envelopeTransferRule=null) |
| Update an envelope transfer rule for an account. This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| EnvelopeTransferRuleInformation | UpdateEnvelopeTransferRules (string accountId, EnvelopeTransferRuleInformation envelopeTransferRuleInformation=null) |
| Update envelope transfer rules for an account. This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| ApiResponse< EnvelopeTransferRuleInformation > | UpdateEnvelopeTransferRulesWithHttpInfo (string accountId, EnvelopeTransferRuleInformation envelopeTransferRuleInformation=null) |
| Update envelope transfer rules for an account. This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| async System.Threading.Tasks.Task< EnvelopeTransferRuleInformation > | UpdateEnvelopeTransferRulesAsync (string accountId, EnvelopeTransferRuleInformation envelopeTransferRuleInformation=null) |
| Update envelope transfer rules for an account. This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| async System.Threading.Tasks.Task< ApiResponse< EnvelopeTransferRuleInformation > > | UpdateEnvelopeTransferRulesAsyncWithHttpInfo (string accountId, EnvelopeTransferRuleInformation envelopeTransferRuleInformation=null) |
| Update envelope transfer rules for an account. This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account. More... | |
| Workflow | UpdateEnvelopeWorkflowDefinition (string accountId, string envelopeId, Workflow workflow=null) |
| Updates the envelope workflow definition for an envelope. Updates the specified envelope's workflow definition if it has one. More... | |
| ApiResponse< Workflow > | UpdateEnvelopeWorkflowDefinitionWithHttpInfo (string accountId, string envelopeId, Workflow workflow=null) |
| Updates the envelope workflow definition for an envelope. Updates the specified envelope's workflow definition if it has one. More... | |
| async System.Threading.Tasks.Task< Workflow > | UpdateEnvelopeWorkflowDefinitionAsync (string accountId, string envelopeId, Workflow workflow=null) |
| Updates the envelope workflow definition for an envelope. Updates the specified envelope's workflow definition if it has one. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Workflow > > | UpdateEnvelopeWorkflowDefinitionAsyncWithHttpInfo (string accountId, string envelopeId, Workflow workflow=null) |
| Updates the envelope workflow definition for an envelope. Updates the specified envelope's workflow definition if it has one. More... | |
| WorkflowStep | UpdateEnvelopeWorkflowStepDefinition (string accountId, string envelopeId, string workflowStepId, WorkflowStep workflowStep=null) |
| Updates the envelope workflow step definition for an envelope. More... | |
| ApiResponse< WorkflowStep > | UpdateEnvelopeWorkflowStepDefinitionWithHttpInfo (string accountId, string envelopeId, string workflowStepId, WorkflowStep workflowStep=null) |
| Updates the envelope workflow step definition for an envelope. More... | |
| async System.Threading.Tasks.Task< WorkflowStep > | UpdateEnvelopeWorkflowStepDefinitionAsync (string accountId, string envelopeId, string workflowStepId, WorkflowStep workflowStep=null) |
| Updates the envelope workflow step definition for an envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< WorkflowStep > > | UpdateEnvelopeWorkflowStepDefinitionAsyncWithHttpInfo (string accountId, string envelopeId, string workflowStepId, WorkflowStep workflowStep=null) |
| Updates the envelope workflow step definition for an envelope. More... | |
| LockInformation | UpdateLock (string accountId, string envelopeId, LockRequest lockRequest=null) |
| Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated. More... | |
| ApiResponse< LockInformation > | UpdateLockWithHttpInfo (string accountId, string envelopeId, LockRequest lockRequest=null) |
| Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated. More... | |
| async System.Threading.Tasks.Task< LockInformation > | UpdateLockAsync (string accountId, string envelopeId, LockRequest lockRequest=null) |
| Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated. More... | |
| async System.Threading.Tasks.Task< ApiResponse< LockInformation > > | UpdateLockAsyncWithHttpInfo (string accountId, string envelopeId, LockRequest lockRequest=null) |
| Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated. More... | |
| Notification | UpdateNotificationSettings (string accountId, string envelopeId, EnvelopeNotificationRequest envelopeNotificationRequest=null) |
| Sets envelope notification (Reminders/Expirations) structure for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages. More... | |
| ApiResponse< Notification > | UpdateNotificationSettingsWithHttpInfo (string accountId, string envelopeId, EnvelopeNotificationRequest envelopeNotificationRequest=null) |
| Sets envelope notification (Reminders/Expirations) structure for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages. More... | |
| async System.Threading.Tasks.Task< Notification > | UpdateNotificationSettingsAsync (string accountId, string envelopeId, EnvelopeNotificationRequest envelopeNotificationRequest=null) |
| Sets envelope notification (Reminders/Expirations) structure for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Notification > > | UpdateNotificationSettingsAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopeNotificationRequest envelopeNotificationRequest=null) |
| Sets envelope notification (Reminders/Expirations) structure for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages. More... | |
| DocumentVisibilityList | UpdateRecipientDocumentVisibility (string accountId, string envelopeId, string recipientId, DocumentVisibilityList documentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| ApiResponse< DocumentVisibilityList > | UpdateRecipientDocumentVisibilityWithHttpInfo (string accountId, string envelopeId, string recipientId, DocumentVisibilityList documentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| async System.Threading.Tasks.Task< DocumentVisibilityList > | UpdateRecipientDocumentVisibilityAsync (string accountId, string envelopeId, string recipientId, DocumentVisibilityList documentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentVisibilityList > > | UpdateRecipientDocumentVisibilityAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, DocumentVisibilityList documentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| void | UpdateRecipientInitialsImage (string accountId, string envelopeId, string recipientId) |
| Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false. More... | |
| ApiResponse< Object > | UpdateRecipientInitialsImageWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false. More... | |
| async System.Threading.Tasks.Task | UpdateRecipientInitialsImageAsync (string accountId, string envelopeId, string recipientId) |
| Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | UpdateRecipientInitialsImageAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false. More... | |
| void | UpdateRecipientSignatureImage (string accountId, string envelopeId, string recipientId) |
| Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false. More... | |
| ApiResponse< Object > | UpdateRecipientSignatureImageWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false. More... | |
| async System.Threading.Tasks.Task | UpdateRecipientSignatureImageAsync (string accountId, string envelopeId, string recipientId) |
| Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | UpdateRecipientSignatureImageAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId) |
| Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false. More... | |
| RecipientsUpdateSummary | UpdateRecipients (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.UpdateRecipientsOptions options=null) |
| Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST). More... | |
| ApiResponse< RecipientsUpdateSummary > | UpdateRecipientsWithHttpInfo (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.UpdateRecipientsOptions options=null) |
| Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST). More... | |
| async System.Threading.Tasks.Task< RecipientsUpdateSummary > | UpdateRecipientsAsync (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.UpdateRecipientsOptions options=null) |
| Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST). More... | |
| async System.Threading.Tasks.Task< ApiResponse< RecipientsUpdateSummary > > | UpdateRecipientsAsyncWithHttpInfo (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.UpdateRecipientsOptions options=null) |
| Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST). More... | |
| DocumentVisibilityList | UpdateRecipientsDocumentVisibility (string accountId, string envelopeId, DocumentVisibilityList documentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| ApiResponse< DocumentVisibilityList > | UpdateRecipientsDocumentVisibilityWithHttpInfo (string accountId, string envelopeId, DocumentVisibilityList documentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| async System.Threading.Tasks.Task< DocumentVisibilityList > | UpdateRecipientsDocumentVisibilityAsync (string accountId, string envelopeId, DocumentVisibilityList documentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DocumentVisibilityList > > | UpdateRecipientsDocumentVisibilityAsyncWithHttpInfo (string accountId, string envelopeId, DocumentVisibilityList documentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| Tabs | UpdateTabs (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Updates the tabs for a recipient. Updates one or more tabs for a recipient in a draft envelope. More... | |
| ApiResponse< Tabs > | UpdateTabsWithHttpInfo (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Updates the tabs for a recipient. Updates one or more tabs for a recipient in a draft envelope. More... | |
| async System.Threading.Tasks.Task< Tabs > | UpdateTabsAsync (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Updates the tabs for a recipient. Updates one or more tabs for a recipient in a draft envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Tabs > > | UpdateTabsAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, Tabs tabs=null) |
| Updates the tabs for a recipient. Updates one or more tabs for a recipient in a draft envelope. More... | |
| void | UpdateTabsBlob (string accountId, string envelopeId) |
| Update encrypted tabs for envelope. More... | |
| ApiResponse< Object > | UpdateTabsBlobWithHttpInfo (string accountId, string envelopeId) |
| Update encrypted tabs for envelope. More... | |
| async System.Threading.Tasks.Task | UpdateTabsBlobAsync (string accountId, string envelopeId) |
| Update encrypted tabs for envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Object > > | UpdateTabsBlobAsyncWithHttpInfo (string accountId, string envelopeId) |
| Update encrypted tabs for envelope. More... | |
| DelayedRouting | UpdateTemplateDelayedRoutingDefinition (string accountId, string templateId, string workflowStepId, DelayedRouting delayedRouting=null) |
| Updates the delayed routing rules for a template's workflow step definition. More... | |
| ApiResponse< DelayedRouting > | UpdateTemplateDelayedRoutingDefinitionWithHttpInfo (string accountId, string templateId, string workflowStepId, DelayedRouting delayedRouting=null) |
| Updates the delayed routing rules for a template's workflow step definition. More... | |
| async System.Threading.Tasks.Task< DelayedRouting > | UpdateTemplateDelayedRoutingDefinitionAsync (string accountId, string templateId, string workflowStepId, DelayedRouting delayedRouting=null) |
| Updates the delayed routing rules for a template's workflow step definition. More... | |
| async System.Threading.Tasks.Task< ApiResponse< DelayedRouting > > | UpdateTemplateDelayedRoutingDefinitionAsyncWithHttpInfo (string accountId, string templateId, string workflowStepId, DelayedRouting delayedRouting=null) |
| Updates the delayed routing rules for a template's workflow step definition. More... | |
| TemplateDocumentVisibilityList | UpdateTemplateRecipientDocumentVisibility (string accountId, string templateId, string recipientId, TemplateDocumentVisibilityList templateDocumentVisibilityList=null) |
| Updates document visibility for the recipients This method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| ApiResponse< TemplateDocumentVisibilityList > | UpdateTemplateRecipientDocumentVisibilityWithHttpInfo (string accountId, string templateId, string recipientId, TemplateDocumentVisibilityList templateDocumentVisibilityList=null) |
| Updates document visibility for the recipients This method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| async System.Threading.Tasks.Task< TemplateDocumentVisibilityList > | UpdateTemplateRecipientDocumentVisibilityAsync (string accountId, string templateId, string recipientId, TemplateDocumentVisibilityList templateDocumentVisibilityList=null) |
| Updates document visibility for the recipients This method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| async System.Threading.Tasks.Task< ApiResponse< TemplateDocumentVisibilityList > > | UpdateTemplateRecipientDocumentVisibilityAsyncWithHttpInfo (string accountId, string templateId, string recipientId, TemplateDocumentVisibilityList templateDocumentVisibilityList=null) |
| Updates document visibility for the recipients This method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| TemplateDocumentVisibilityList | UpdateTemplateRecipientsDocumentVisibility (string accountId, string templateId, TemplateDocumentVisibilityList templateDocumentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| ApiResponse< TemplateDocumentVisibilityList > | UpdateTemplateRecipientsDocumentVisibilityWithHttpInfo (string accountId, string templateId, TemplateDocumentVisibilityList templateDocumentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| async System.Threading.Tasks.Task< TemplateDocumentVisibilityList > | UpdateTemplateRecipientsDocumentVisibilityAsync (string accountId, string templateId, TemplateDocumentVisibilityList templateDocumentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| async System.Threading.Tasks.Task< ApiResponse< TemplateDocumentVisibilityList > > | UpdateTemplateRecipientsDocumentVisibilityAsyncWithHttpInfo (string accountId, string templateId, TemplateDocumentVisibilityList templateDocumentVisibilityList=null) |
| Updates document visibility for the recipients This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents. More... | |
| ScheduledSending | UpdateTemplateScheduledSendingDefinition (string accountId, string templateId, ScheduledSending scheduledSending=null) |
| Updates the scheduled sending rules for a template's workflow definition. More... | |
| ApiResponse< ScheduledSending > | UpdateTemplateScheduledSendingDefinitionWithHttpInfo (string accountId, string templateId, ScheduledSending scheduledSending=null) |
| Updates the scheduled sending rules for a template's workflow definition. More... | |
| async System.Threading.Tasks.Task< ScheduledSending > | UpdateTemplateScheduledSendingDefinitionAsync (string accountId, string templateId, ScheduledSending scheduledSending=null) |
| Updates the scheduled sending rules for a template's workflow definition. More... | |
| async System.Threading.Tasks.Task< ApiResponse< ScheduledSending > > | UpdateTemplateScheduledSendingDefinitionAsyncWithHttpInfo (string accountId, string templateId, ScheduledSending scheduledSending=null) |
| Updates the scheduled sending rules for a template's workflow definition. More... | |
| Workflow | UpdateTemplateWorkflowDefinition (string accountId, string templateId, Workflow workflow=null) |
| Updates the workflow definition for a template. Updates the specified template's workflow definition if it has one. More... | |
| ApiResponse< Workflow > | UpdateTemplateWorkflowDefinitionWithHttpInfo (string accountId, string templateId, Workflow workflow=null) |
| Updates the workflow definition for a template. Updates the specified template's workflow definition if it has one. More... | |
| async System.Threading.Tasks.Task< Workflow > | UpdateTemplateWorkflowDefinitionAsync (string accountId, string templateId, Workflow workflow=null) |
| Updates the workflow definition for a template. Updates the specified template's workflow definition if it has one. More... | |
| async System.Threading.Tasks.Task< ApiResponse< Workflow > > | UpdateTemplateWorkflowDefinitionAsyncWithHttpInfo (string accountId, string templateId, Workflow workflow=null) |
| Updates the workflow definition for a template. Updates the specified template's workflow definition if it has one. More... | |
| WorkflowStep | UpdateTemplateWorkflowStepDefinition (string accountId, string templateId, string workflowStepId, WorkflowStep workflowStep=null) |
| Updates the template workflow step definition for an envelope. More... | |
| ApiResponse< WorkflowStep > | UpdateTemplateWorkflowStepDefinitionWithHttpInfo (string accountId, string templateId, string workflowStepId, WorkflowStep workflowStep=null) |
| Updates the template workflow step definition for an envelope. More... | |
| async System.Threading.Tasks.Task< WorkflowStep > | UpdateTemplateWorkflowStepDefinitionAsync (string accountId, string templateId, string workflowStepId, WorkflowStep workflowStep=null) |
| Updates the template workflow step definition for an envelope. More... | |
| async System.Threading.Tasks.Task< ApiResponse< WorkflowStep > > | UpdateTemplateWorkflowStepDefinitionAsyncWithHttpInfo (string accountId, string templateId, string workflowStepId, WorkflowStep workflowStep=null) |
| Updates the template workflow step definition for an envelope. More... | |
 Public Member Functions inherited from DocuSign.eSign.Api.IEnvelopesApi | |
| DocumentTemplateList | ApplyTemplate (string accountId, string envelopeId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateOptions options=null) |
| Adds templates to an envelope. More... | |
| ApiResponse< DocumentTemplateList > | ApplyTemplateWithHttpInfo (string accountId, string envelopeId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateOptions options=null) |
| Adds templates to an envelope. More... | |
| DocumentTemplateList | ApplyTemplateToDocument (string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateToDocumentOptions options=null) |
| Adds templates to a document in an envelope. More... | |
| ApiResponse< DocumentTemplateList > | ApplyTemplateToDocumentWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateToDocumentOptions options=null) |
| Adds templates to a document in an envelope. More... | |
| EnvelopeSummary | CreateEnvelope (string accountId, EnvelopeDefinition envelopeDefinition=null, EnvelopesApi.CreateEnvelopeOptions options=null) |
| Creates an envelope. More... | |
| ApiResponse< EnvelopeSummary > | CreateEnvelopeWithHttpInfo (string accountId, EnvelopeDefinition envelopeDefinition=null, EnvelopesApi.CreateEnvelopeOptions options=null) |
| Creates an envelope. More... | |
| Recipients | CreateRecipient (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.CreateRecipientOptions options=null) |
| Adds one or more recipients to an envelope. More... | |
| ApiResponse< Recipients > | CreateRecipientWithHttpInfo (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.CreateRecipientOptions options=null) |
| Adds one or more recipients to an envelope. More... | |
| ChunkedUploadResponse | GetChunkedUpload (string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options=null) |
| Retrieves the current metadata of a ChunkedUpload. More... | |
| ApiResponse< ChunkedUploadResponse > | GetChunkedUploadWithHttpInfo (string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options=null) |
| Retrieves the current metadata of a ChunkedUpload. More... | |
| System.IO.Stream | GetCommentsTranscript (string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options=null) |
| Gets comment transcript for envelope and user More... | |
| ApiResponse< System.IO.Stream > | GetCommentsTranscriptWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options=null) |
| Gets comment transcript for envelope and user More... | |
| ConsumerDisclosure | GetConsumerDisclosure (string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options=null) |
| Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. More... | |
| ApiResponse< ConsumerDisclosure > | GetConsumerDisclosureWithHttpInfo (string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options=null) |
| Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. More... | |
| ConsumerDisclosure | GetConsumerDisclosureDefault (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options=null) |
| Gets the Electronic Record and Signature Disclosure associated with the account. More... | |
| ApiResponse< ConsumerDisclosure > | GetConsumerDisclosureDefaultWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options=null) |
| Gets the Electronic Record and Signature Disclosure associated with the account. More... | |
| System.IO.Stream | GetDocument (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options=null) |
| Gets a document from an envelope. More... | |
| ApiResponse< System.IO.Stream > | GetDocumentWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options=null) |
| Gets a document from an envelope. More... | |
| System.IO.Stream | GetDocumentPageImage (string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options=null) |
| Gets a page image from an envelope for display. More... | |
| ApiResponse< System.IO.Stream > | GetDocumentPageImageWithHttpInfo (string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options=null) |
| Gets a page image from an envelope for display. More... | |
| Tabs | GetDocumentTabs (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options=null) |
| Returns tabs on the document. More... | |
| ApiResponse< Tabs > | GetDocumentTabsWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options=null) |
| Returns tabs on the document. More... | |
| Envelope | GetEnvelope (string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options=null) |
| Gets the status of a envelope. More... | |
| ApiResponse< Envelope > | GetEnvelopeWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options=null) |
| Gets the status of a envelope. More... | |
| EnvelopeTransferRuleInformation | GetEnvelopeTransferRules (string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options=null) |
| Returns a list of envelope transfer rules in the specified account. More... | |
| ApiResponse< EnvelopeTransferRuleInformation > | GetEnvelopeTransferRulesWithHttpInfo (string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options=null) |
| Returns a list of envelope transfer rules in the specified account. More... | |
| PageImages | GetPages (string accountId, string envelopeId, string documentId, EnvelopesApi.GetPagesOptions options=null) |
| Returns document page image(s) based on input. More... | |
| ApiResponse< PageImages > | GetPagesWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetPagesOptions options=null) |
| Returns document page image(s) based on input. More... | |
| System.IO.Stream | GetRecipientInitialsImage (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientInitialsImageOptions options=null) |
| Gets the initials image for a user. More... | |
| ApiResponse< System.IO.Stream > | GetRecipientInitialsImageWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientInitialsImageOptions options=null) |
| Gets the initials image for a user. More... | |
| System.IO.Stream | GetRecipientSignatureImage (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientSignatureImageOptions options=null) |
| Retrieve signature image information for a signer/sign-in-person recipient. More... | |
| ApiResponse< System.IO.Stream > | GetRecipientSignatureImageWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientSignatureImageOptions options=null) |
| Retrieve signature image information for a signer/sign-in-person recipient. More... | |
| EnvelopeDocumentsResult | ListDocuments (string accountId, string envelopeId, EnvelopesApi.ListDocumentsOptions options=null) |
| Gets a list of envelope documents. More... | |
| ApiResponse< EnvelopeDocumentsResult > | ListDocumentsWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListDocumentsOptions options=null) |
| Gets a list of envelope documents. More... | |
| Recipients | ListRecipients (string accountId, string envelopeId, EnvelopesApi.ListRecipientsOptions options=null) |
| Gets the status of recipients for an envelope. More... | |
| ApiResponse< Recipients > | ListRecipientsWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListRecipientsOptions options=null) |
| Gets the status of recipients for an envelope. More... | |
| EnvelopesInformation | ListStatus (string accountId, EnvelopeIdsRequest envelopeIdsRequest=null, EnvelopesApi.ListStatusOptions options=null) |
| Gets the envelope status for the specified envelopes. More... | |
| ApiResponse< EnvelopesInformation > | ListStatusWithHttpInfo (string accountId, EnvelopeIdsRequest envelopeIdsRequest=null, EnvelopesApi.ListStatusOptions options=null) |
| Gets the envelope status for the specified envelopes. More... | |
| EnvelopesInformation | ListStatusChanges (string accountId, EnvelopesApi.ListStatusChangesOptions options=null) |
| Gets status changes for one or more envelopes. More... | |
| ApiResponse< EnvelopesInformation > | ListStatusChangesWithHttpInfo (string accountId, EnvelopesApi.ListStatusChangesOptions options=null) |
| Gets status changes for one or more envelopes. More... | |
| Tabs | ListTabs (string accountId, string envelopeId, string recipientId, EnvelopesApi.ListTabsOptions options=null) |
| Gets the tabs information for a signer or sign-in-person recipient in an envelope. More... | |
| ApiResponse< Tabs > | ListTabsWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.ListTabsOptions options=null) |
| Gets the tabs information for a signer or sign-in-person recipient in an envelope. More... | |
| TemplateInformation | ListTemplates (string accountId, string envelopeId, EnvelopesApi.ListTemplatesOptions options=null) |
| Get List of Templates used in an Envelope More... | |
| ApiResponse< TemplateInformation > | ListTemplatesWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListTemplatesOptions options=null) |
| Get List of Templates used in an Envelope More... | |
| TemplateInformation | ListTemplatesForDocument (string accountId, string envelopeId, string documentId, EnvelopesApi.ListTemplatesForDocumentOptions options=null) |
| Gets the templates associated with a document in an existing envelope. More... | |
| ApiResponse< TemplateInformation > | ListTemplatesForDocumentWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.ListTemplatesForDocumentOptions options=null) |
| Gets the templates associated with a document in an existing envelope. More... | |
| EnvelopeUpdateSummary | Update (string accountId, string envelopeId, Envelope envelope=null, EnvelopesApi.UpdateOptions options=null) |
| Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft More... | |
| ApiResponse< EnvelopeUpdateSummary > | UpdateWithHttpInfo (string accountId, string envelopeId, Envelope envelope=null, EnvelopesApi.UpdateOptions options=null) |
| Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft More... | |
| ChunkedUploadResponse | UpdateChunkedUpload (string accountId, string chunkedUploadId, EnvelopesApi.UpdateChunkedUploadOptions options=null) |
| Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. More... | |
| ApiResponse< ChunkedUploadResponse > | UpdateChunkedUploadWithHttpInfo (string accountId, string chunkedUploadId, EnvelopesApi.UpdateChunkedUploadOptions options=null) |
| Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. More... | |
| DocGenFormFieldResponse | UpdateEnvelopeDocGenFormFields (string accountId, string envelopeId, DocGenFormFieldRequest docGenFormFieldRequest=null, EnvelopesApi.UpdateEnvelopeDocGenFormFieldsOptions options=null) |
| Updates formfields for an envelope More... | |
| ApiResponse< DocGenFormFieldResponse > | UpdateEnvelopeDocGenFormFieldsWithHttpInfo (string accountId, string envelopeId, DocGenFormFieldRequest docGenFormFieldRequest=null, EnvelopesApi.UpdateEnvelopeDocGenFormFieldsOptions options=null) |
| Updates formfields for an envelope More... | |
| RecipientsUpdateSummary | UpdateRecipients (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.UpdateRecipientsOptions options=null) |
| Updates recipients in a draft envelope or corrects recipient information for an in process envelope. More... | |
| ApiResponse< RecipientsUpdateSummary > | UpdateRecipientsWithHttpInfo (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.UpdateRecipientsOptions options=null) |
| Updates recipients in a draft envelope or corrects recipient information for an in process envelope. More... | |
| System.Threading.Tasks.Task< DocumentTemplateList > | ApplyTemplateAsync (string accountId, string envelopeId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateOptions options=null) |
| Adds templates to an envelope. More... | |
| System.Threading.Tasks.Task< ApiResponse< DocumentTemplateList > > | ApplyTemplateAsyncWithHttpInfo (string accountId, string envelopeId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateOptions options=null) |
| Adds templates to an envelope. More... | |
| System.Threading.Tasks.Task< DocumentTemplateList > | ApplyTemplateToDocumentAsync (string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateToDocumentOptions options=null) |
| Adds templates to a document in an envelope. More... | |
| System.Threading.Tasks.Task< ApiResponse< DocumentTemplateList > > | ApplyTemplateToDocumentAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, DocumentTemplateList documentTemplateList=null, EnvelopesApi.ApplyTemplateToDocumentOptions options=null) |
| Adds templates to a document in an envelope. More... | |
| System.Threading.Tasks.Task< EnvelopeSummary > | CreateEnvelopeAsync (string accountId, EnvelopeDefinition envelopeDefinition=null, EnvelopesApi.CreateEnvelopeOptions options=null) |
| Creates an envelope. More... | |
| System.Threading.Tasks.Task< ApiResponse< EnvelopeSummary > > | CreateEnvelopeAsyncWithHttpInfo (string accountId, EnvelopeDefinition envelopeDefinition=null, EnvelopesApi.CreateEnvelopeOptions options=null) |
| Creates an envelope. More... | |
| System.Threading.Tasks.Task< Recipients > | CreateRecipientAsync (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.CreateRecipientOptions options=null) |
| Adds one or more recipients to an envelope. More... | |
| System.Threading.Tasks.Task< ApiResponse< Recipients > > | CreateRecipientAsyncWithHttpInfo (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.CreateRecipientOptions options=null) |
| Adds one or more recipients to an envelope. More... | |
| System.Threading.Tasks.Task< ChunkedUploadResponse > | GetChunkedUploadAsync (string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options=null) |
| Retrieves the current metadata of a ChunkedUpload. More... | |
| System.Threading.Tasks.Task< ApiResponse< ChunkedUploadResponse > > | GetChunkedUploadAsyncWithHttpInfo (string accountId, string chunkedUploadId, EnvelopesApi.GetChunkedUploadOptions options=null) |
| Retrieves the current metadata of a ChunkedUpload. More... | |
| System.Threading.Tasks.Task< System.IO.Stream > | GetCommentsTranscriptAsync (string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options=null) |
| Gets comment transcript for envelope and user More... | |
| System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetCommentsTranscriptAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.GetCommentsTranscriptOptions options=null) |
| Gets comment transcript for envelope and user More... | |
| System.Threading.Tasks.Task< ConsumerDisclosure > | GetConsumerDisclosureAsync (string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options=null) |
| Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. More... | |
| System.Threading.Tasks.Task< ApiResponse< ConsumerDisclosure > > | GetConsumerDisclosureAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, string langCode, EnvelopesApi.GetConsumerDisclosureOptions options=null) |
| Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. More... | |
| System.Threading.Tasks.Task< ConsumerDisclosure > | GetConsumerDisclosureDefaultAsync (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options=null) |
| Gets the Electronic Record and Signature Disclosure associated with the account. More... | |
| System.Threading.Tasks.Task< ApiResponse< ConsumerDisclosure > > | GetConsumerDisclosureDefaultAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetConsumerDisclosureDefaultOptions options=null) |
| Gets the Electronic Record and Signature Disclosure associated with the account. More... | |
| System.Threading.Tasks.Task< System.IO.Stream > | GetDocumentAsync (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options=null) |
| Gets a document from an envelope. More... | |
| System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetDocumentAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentOptions options=null) |
| Gets a document from an envelope. More... | |
| System.Threading.Tasks.Task< System.IO.Stream > | GetDocumentPageImageAsync (string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options=null) |
| Gets a page image from an envelope for display. More... | |
| System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetDocumentPageImageAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, string pageNumber, EnvelopesApi.GetDocumentPageImageOptions options=null) |
| Gets a page image from an envelope for display. More... | |
| System.Threading.Tasks.Task< Tabs > | GetDocumentTabsAsync (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options=null) |
| Returns tabs on the document. More... | |
| System.Threading.Tasks.Task< ApiResponse< Tabs > > | GetDocumentTabsAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetDocumentTabsOptions options=null) |
| Returns tabs on the document. More... | |
| System.Threading.Tasks.Task< Envelope > | GetEnvelopeAsync (string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options=null) |
| Gets the status of a envelope. More... | |
| System.Threading.Tasks.Task< ApiResponse< Envelope > > | GetEnvelopeAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.GetEnvelopeOptions options=null) |
| Gets the status of a envelope. More... | |
| System.Threading.Tasks.Task< EnvelopeTransferRuleInformation > | GetEnvelopeTransferRulesAsync (string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options=null) |
| Returns a list of envelope transfer rules in the specified account. More... | |
| System.Threading.Tasks.Task< ApiResponse< EnvelopeTransferRuleInformation > > | GetEnvelopeTransferRulesAsyncWithHttpInfo (string accountId, EnvelopesApi.GetEnvelopeTransferRulesOptions options=null) |
| Returns a list of envelope transfer rules in the specified account. More... | |
| System.Threading.Tasks.Task< PageImages > | GetPagesAsync (string accountId, string envelopeId, string documentId, EnvelopesApi.GetPagesOptions options=null) |
| Returns document page image(s) based on input. More... | |
| System.Threading.Tasks.Task< ApiResponse< PageImages > > | GetPagesAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.GetPagesOptions options=null) |
| Returns document page image(s) based on input. More... | |
| System.Threading.Tasks.Task< System.IO.Stream > | GetRecipientInitialsImageAsync (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientInitialsImageOptions options=null) |
| Gets the initials image for a user. More... | |
| System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetRecipientInitialsImageAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientInitialsImageOptions options=null) |
| Gets the initials image for a user. More... | |
| System.Threading.Tasks.Task< System.IO.Stream > | GetRecipientSignatureImageAsync (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientSignatureImageOptions options=null) |
| Retrieve signature image information for a signer/sign-in-person recipient. More... | |
| System.Threading.Tasks.Task< ApiResponse< System.IO.Stream > > | GetRecipientSignatureImageAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.GetRecipientSignatureImageOptions options=null) |
| Retrieve signature image information for a signer/sign-in-person recipient. More... | |
| System.Threading.Tasks.Task< EnvelopeDocumentsResult > | ListDocumentsAsync (string accountId, string envelopeId, EnvelopesApi.ListDocumentsOptions options=null) |
| Gets a list of envelope documents. More... | |
| System.Threading.Tasks.Task< ApiResponse< EnvelopeDocumentsResult > > | ListDocumentsAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListDocumentsOptions options=null) |
| Gets a list of envelope documents. More... | |
| System.Threading.Tasks.Task< Recipients > | ListRecipientsAsync (string accountId, string envelopeId, EnvelopesApi.ListRecipientsOptions options=null) |
| Gets the status of recipients for an envelope. More... | |
| System.Threading.Tasks.Task< ApiResponse< Recipients > > | ListRecipientsAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListRecipientsOptions options=null) |
| Gets the status of recipients for an envelope. More... | |
| System.Threading.Tasks.Task< EnvelopesInformation > | ListStatusAsync (string accountId, EnvelopeIdsRequest envelopeIdsRequest=null, EnvelopesApi.ListStatusOptions options=null) |
| Gets the envelope status for the specified envelopes. More... | |
| System.Threading.Tasks.Task< ApiResponse< EnvelopesInformation > > | ListStatusAsyncWithHttpInfo (string accountId, EnvelopeIdsRequest envelopeIdsRequest=null, EnvelopesApi.ListStatusOptions options=null) |
| Gets the envelope status for the specified envelopes. More... | |
| System.Threading.Tasks.Task< EnvelopesInformation > | ListStatusChangesAsync (string accountId, EnvelopesApi.ListStatusChangesOptions options=null) |
| Gets status changes for one or more envelopes. More... | |
| System.Threading.Tasks.Task< ApiResponse< EnvelopesInformation > > | ListStatusChangesAsyncWithHttpInfo (string accountId, EnvelopesApi.ListStatusChangesOptions options=null) |
| Gets status changes for one or more envelopes. More... | |
| System.Threading.Tasks.Task< Tabs > | ListTabsAsync (string accountId, string envelopeId, string recipientId, EnvelopesApi.ListTabsOptions options=null) |
| Gets the tabs information for a signer or sign-in-person recipient in an envelope. More... | |
| System.Threading.Tasks.Task< ApiResponse< Tabs > > | ListTabsAsyncWithHttpInfo (string accountId, string envelopeId, string recipientId, EnvelopesApi.ListTabsOptions options=null) |
| Gets the tabs information for a signer or sign-in-person recipient in an envelope. More... | |
| System.Threading.Tasks.Task< TemplateInformation > | ListTemplatesAsync (string accountId, string envelopeId, EnvelopesApi.ListTemplatesOptions options=null) |
| Get List of Templates used in an Envelope More... | |
| System.Threading.Tasks.Task< ApiResponse< TemplateInformation > > | ListTemplatesAsyncWithHttpInfo (string accountId, string envelopeId, EnvelopesApi.ListTemplatesOptions options=null) |
| Get List of Templates used in an Envelope More... | |
| System.Threading.Tasks.Task< TemplateInformation > | ListTemplatesForDocumentAsync (string accountId, string envelopeId, string documentId, EnvelopesApi.ListTemplatesForDocumentOptions options=null) |
| Gets the templates associated with a document in an existing envelope. More... | |
| System.Threading.Tasks.Task< ApiResponse< TemplateInformation > > | ListTemplatesForDocumentAsyncWithHttpInfo (string accountId, string envelopeId, string documentId, EnvelopesApi.ListTemplatesForDocumentOptions options=null) |
| Gets the templates associated with a document in an existing envelope. More... | |
| System.Threading.Tasks.Task< EnvelopeUpdateSummary > | UpdateAsync (string accountId, string envelopeId, Envelope envelope=null, EnvelopesApi.UpdateOptions options=null) |
| Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft More... | |
| System.Threading.Tasks.Task< ApiResponse< EnvelopeUpdateSummary > > | UpdateAsyncWithHttpInfo (string accountId, string envelopeId, Envelope envelope=null, EnvelopesApi.UpdateOptions options=null) |
| Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft More... | |
| System.Threading.Tasks.Task< ChunkedUploadResponse > | UpdateChunkedUploadAsync (string accountId, string chunkedUploadId, EnvelopesApi.UpdateChunkedUploadOptions options=null) |
| Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. More... | |
| System.Threading.Tasks.Task< ApiResponse< ChunkedUploadResponse > > | UpdateChunkedUploadAsyncWithHttpInfo (string accountId, string chunkedUploadId, EnvelopesApi.UpdateChunkedUploadOptions options=null) |
| Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. More... | |
| System.Threading.Tasks.Task< DocGenFormFieldResponse > | UpdateEnvelopeDocGenFormFieldsAsync (string accountId, string envelopeId, DocGenFormFieldRequest docGenFormFieldRequest=null, EnvelopesApi.UpdateEnvelopeDocGenFormFieldsOptions options=null) |
| Updates formfields for an envelope More... | |
| System.Threading.Tasks.Task< ApiResponse< DocGenFormFieldResponse > > | UpdateEnvelopeDocGenFormFieldsAsyncWithHttpInfo (string accountId, string envelopeId, DocGenFormFieldRequest docGenFormFieldRequest=null, EnvelopesApi.UpdateEnvelopeDocGenFormFieldsOptions options=null) |
| Updates formfields for an envelope More... | |
| System.Threading.Tasks.Task< RecipientsUpdateSummary > | UpdateRecipientsAsync (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.UpdateRecipientsOptions options=null) |
| Updates recipients in a draft envelope or corrects recipient information for an in process envelope. More... | |
| System.Threading.Tasks.Task< ApiResponse< RecipientsUpdateSummary > > | UpdateRecipientsAsyncWithHttpInfo (string accountId, string envelopeId, Recipients recipients=null, EnvelopesApi.UpdateRecipientsOptions options=null) |
| Updates recipients in a draft envelope or corrects recipient information for an in process envelope. More... | |
Properties | |
| DocuSignClient | ApiClient [get, set] |
| Gets or sets the ApiClient object More... | |
| DocuSign.eSign.Client.ExceptionFactory | ExceptionFactory [get, set] |
| Provides a factory method hook for the creation of exceptions. More... | |
| Properties inherited from DocuSign.eSign.Client.IApiAccessor | |
| DocuSignClient | ApiClient [get, set] |
| Gets or sets the ApiClient object More... | |
| ExceptionFactory | ExceptionFactory [get, set] |
| Provides a factory method hook for the creation of exceptions. More... | |
Detailed Description
Represents a collection of functions to interact with the API endpoints
Constructor & Destructor Documentation
◆ EnvelopesApi()
|
inline |
Initializes a new instance of the EnvelopesApi class using AplClient object
- Parameters
-
aplClient An instance of AplClient
- Returns
Member Function Documentation
◆ ApplyTemplate()
|
inline |
Adds templates to an envelope. Adds templates to the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentTemplateList (optional) options Options for modifying the behavior of the function.
- Returns
- DocumentTemplateList
◆ ApplyTemplateAsync()
|
inline |
Adds templates to an envelope. Adds templates to the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentTemplateList (optional) options Options for modifying the behavior of the function.
- Returns
- Task of DocumentTemplateList
◆ ApplyTemplateAsyncWithHttpInfo()
|
inline |
Adds templates to an envelope. Adds templates to the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentTemplateList (optional) options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (DocumentTemplateList)
◆ ApplyTemplateToDocument()
|
inline |
Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentTemplateList (optional) options Options for modifying the behavior of the function.
- Returns
- DocumentTemplateList
◆ ApplyTemplateToDocumentAsync()
|
inline |
Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentTemplateList (optional) options Options for modifying the behavior of the function.
- Returns
- Task of DocumentTemplateList
◆ ApplyTemplateToDocumentAsyncWithHttpInfo()
|
inline |
Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentTemplateList (optional) options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (DocumentTemplateList)
◆ ApplyTemplateToDocumentWithHttpInfo()
|
inline |
Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentTemplateList (optional) options Options for modifying the behavior of the function.
- Returns
- ApiResponse of DocumentTemplateList
◆ ApplyTemplateWithHttpInfo()
|
inline |
Adds templates to an envelope. Adds templates to the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentTemplateList (optional) options Options for modifying the behavior of the function.
- Returns
- ApiResponse of DocumentTemplateList
◆ CreateChunkedUpload()
|
inline |
Initiate a new ChunkedUpload. This method initiates a new chunked upload with the first part of the content.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadRequest (optional)
- Returns
- ChunkedUploadResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateChunkedUploadAsync()
|
inline |
Initiate a new ChunkedUpload. This method initiates a new chunked upload with the first part of the content.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadRequest (optional)
- Returns
- Task of ChunkedUploadResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateChunkedUploadAsyncWithHttpInfo()
|
inline |
Initiate a new ChunkedUpload. This method initiates a new chunked upload with the first part of the content.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadRequest (optional)
- Returns
- Task of ApiResponse (ChunkedUploadResponse)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateChunkedUploadWithHttpInfo()
|
inline |
Initiate a new ChunkedUpload. This method initiates a new chunked upload with the first part of the content.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadRequest (optional)
- Returns
- ApiResponse of ChunkedUploadResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateConsoleView()
|
inline |
Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. consoleViewRequest (optional)
- Returns
- ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateConsoleViewAsync()
|
inline |
Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. consoleViewRequest (optional)
- Returns
- Task of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateConsoleViewAsyncWithHttpInfo()
|
inline |
Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. consoleViewRequest (optional)
- Returns
- Task of ApiResponse (ViewUrl)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateConsoleViewWithHttpInfo()
|
inline |
Returns a URL to the authentication view UI. Returns a URL that allows you to embed the authentication view of the DocuSign UI in your applications.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. consoleViewRequest (optional)
- Returns
- ApiResponse of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateCorrectView()
|
inline |
Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. correctViewRequest (optional)
- Returns
- ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateCorrectViewAsync()
|
inline |
Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. correctViewRequest (optional)
- Returns
- Task of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateCorrectViewAsyncWithHttpInfo()
|
inline |
Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. correctViewRequest (optional)
- Returns
- Task of ApiResponse (ViewUrl)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateCorrectViewWithHttpInfo()
|
inline |
Returns a URL to the envelope correction UI. Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. correctViewRequest (optional)
- Returns
- ApiResponse of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateCustomFields()
|
inline |
Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- CustomFields
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateCustomFieldsAsync()
|
inline |
Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- Task of CustomFields
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateCustomFieldsAsyncWithHttpInfo()
|
inline |
Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- Task of ApiResponse (CustomFields)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateCustomFieldsWithHttpInfo()
|
inline |
Updates envelope custom fields for an envelope. Updates the envelope custom fields for draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- ApiResponse of CustomFields
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentFields()
|
inline |
Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentFieldsAsync()
|
inline |
Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- Task of DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentFieldsAsyncWithHttpInfo()
|
inline |
Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- Task of ApiResponse (DocumentFieldsInformation)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentFieldsWithHttpInfo()
|
inline |
Creates custom document fields in an existing envelope document. Creates custom document fields in an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- ApiResponse of DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentResponsiveHtmlPreview()
|
inline |
Get Responsive HTML Preview for a document in an envelope. Creates a preview of the responsive HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentHtmlDefinition (optional)
- Returns
- DocumentHtmlDefinitions
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentResponsiveHtmlPreviewAsync()
|
inline |
Get Responsive HTML Preview for a document in an envelope. Creates a preview of the responsive HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentHtmlDefinition (optional)
- Returns
- Task of DocumentHtmlDefinitions
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentResponsiveHtmlPreviewAsyncWithHttpInfo()
|
inline |
Get Responsive HTML Preview for a document in an envelope. Creates a preview of the responsive HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentHtmlDefinition (optional)
- Returns
- Task of ApiResponse (DocumentHtmlDefinitions)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentResponsiveHtmlPreviewWithHttpInfo()
|
inline |
Get Responsive HTML Preview for a document in an envelope. Creates a preview of the responsive HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentHtmlDefinition (optional)
- Returns
- ApiResponse of DocumentHtmlDefinitions
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentTabs()
|
inline |
Adds the tabs to an envelope document Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentTabsAsync()
|
inline |
Adds the tabs to an envelope document Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- Task of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentTabsAsyncWithHttpInfo()
|
inline |
Adds the tabs to an envelope document Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- Task of ApiResponse (Tabs)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateDocumentTabsWithHttpInfo()
|
inline |
Adds the tabs to an envelope document Adds tabs to the document specified by `documentId` in the envelope specified by `envelopeId`. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: ``` { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } } ```
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- ApiResponse of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEditView()
|
inline |
Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. returnUrlRequest (optional)
- Returns
- ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEditViewAsync()
|
inline |
Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. returnUrlRequest (optional)
- Returns
- Task of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEditViewAsyncWithHttpInfo()
|
inline |
Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. returnUrlRequest (optional)
- Returns
- Task of ApiResponse (ViewUrl)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEditViewWithHttpInfo()
|
inline |
Returns a URL to the edit view UI. Returns a URL that allows you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. returnUrlRequest (optional)
- Returns
- ApiResponse of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEmailSettings()
|
inline |
Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. emailSettings (optional)
- Returns
- EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEmailSettingsAsync()
|
inline |
Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. emailSettings (optional)
- Returns
- Task of EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEmailSettingsAsyncWithHttpInfo()
|
inline |
Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. emailSettings (optional)
- Returns
- Task of ApiResponse (EmailSettings)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEmailSettingsWithHttpInfo()
|
inline |
Adds email setting overrides to an envelope. Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made. ### Important: The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copies or Certified Deliveries Recipient Type.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. emailSettings (optional)
- Returns
- ApiResponse of EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelope()
|
inline |
Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the `document` object ### Recipient Types An `envelopeDefinition` object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an `EnvelopeRecipients` resource object. It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - – – – – – – - | - – – – – – – – – agent (can add name and email information for later recipients/signers) | `agent` carbon copy (receives a copy of the documents) | `carbonCopy` certified delivery (receives a copy of the documents and must acknowledge receipt) | `certifiedDelivery` editor (can change recipients and document fields for later recipients/signers) | `editor` in-person signer ("hosts" someone who signs in-person) | `inPersonSigner` intermediary (can add name and email information for some later recipients/signers.) | `intermediary` signer (signs and/or updates document fields) | `signer` Additional information about the different types of recipients is available from the `EnvelopeRecipients` resource page and from the Developer Center ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an `EnvelopeTabs` resource object. It includes arrays of the 24 different tab types available. See the `EnvelopeTabs` resource for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the `EnvelopeRecipients` object are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the Webhook recipe for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the first template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "\*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a PDF Form Digital Signature Field, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming PDF Form Text Fields, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeDefinition (optional) options Options for modifying the behavior of the function.
- Returns
- EnvelopeSummary
◆ CreateEnvelopeAsync()
|
inline |
Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the `document` object ### Recipient Types An `envelopeDefinition` object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an `EnvelopeRecipients` resource object. It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - – – – – – – - | - – – – – – – – – agent (can add name and email information for later recipients/signers) | `agent` carbon copy (receives a copy of the documents) | `carbonCopy` certified delivery (receives a copy of the documents and must acknowledge receipt) | `certifiedDelivery` editor (can change recipients and document fields for later recipients/signers) | `editor` in-person signer ("hosts" someone who signs in-person) | `inPersonSigner` intermediary (can add name and email information for some later recipients/signers.) | `intermediary` signer (signs and/or updates document fields) | `signer` Additional information about the different types of recipients is available from the `EnvelopeRecipients` resource page and from the Developer Center ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an `EnvelopeTabs` resource object. It includes arrays of the 24 different tab types available. See the `EnvelopeTabs` resource for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the `EnvelopeRecipients` object are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the Webhook recipe for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the first template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "\*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a PDF Form Digital Signature Field, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming PDF Form Text Fields, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeDefinition (optional) options Options for modifying the behavior of the function.
- Returns
- Task of EnvelopeSummary
◆ CreateEnvelopeAsyncWithHttpInfo()
|
inline |
Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the `document` object ### Recipient Types An `envelopeDefinition` object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an `EnvelopeRecipients` resource object. It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - – – – – – – - | - – – – – – – – – agent (can add name and email information for later recipients/signers) | `agent` carbon copy (receives a copy of the documents) | `carbonCopy` certified delivery (receives a copy of the documents and must acknowledge receipt) | `certifiedDelivery` editor (can change recipients and document fields for later recipients/signers) | `editor` in-person signer ("hosts" someone who signs in-person) | `inPersonSigner` intermediary (can add name and email information for some later recipients/signers.) | `intermediary` signer (signs and/or updates document fields) | `signer` Additional information about the different types of recipients is available from the `EnvelopeRecipients` resource page and from the Developer Center ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an `EnvelopeTabs` resource object. It includes arrays of the 24 different tab types available. See the `EnvelopeTabs` resource for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the `EnvelopeRecipients` object are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the Webhook recipe for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the first template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "\*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a PDF Form Digital Signature Field, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming PDF Form Text Fields, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeDefinition (optional) options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (EnvelopeSummary)
◆ CreateEnvelopeComments()
|
inline |
Posts a list of comments for authorized user
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. commentsPublish (optional)
- Returns
- CommentHistoryResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeCommentsAsync()
|
inline |
Posts a list of comments for authorized user
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. commentsPublish (optional)
- Returns
- Task of CommentHistoryResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeCommentsAsyncWithHttpInfo()
|
inline |
Posts a list of comments for authorized user
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. commentsPublish (optional)
- Returns
- Task of ApiResponse (CommentHistoryResult)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeCommentsWithHttpInfo()
|
inline |
Posts a list of comments for authorized user
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. commentsPublish (optional)
- Returns
- ApiResponse of CommentHistoryResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeRecipientPreview()
|
inline |
Provides a URL to start a recipient view of the Envelope UI This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientPreviewRequest (optional)
- Returns
- ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeRecipientPreviewAsync()
|
inline |
Provides a URL to start a recipient view of the Envelope UI This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientPreviewRequest (optional)
- Returns
- Task of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeRecipientPreviewAsyncWithHttpInfo()
|
inline |
Provides a URL to start a recipient view of the Envelope UI This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientPreviewRequest (optional)
- Returns
- Task of ApiResponse (ViewUrl)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeRecipientPreviewWithHttpInfo()
|
inline |
Provides a URL to start a recipient view of the Envelope UI This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientPreviewRequest (optional)
- Returns
- ApiResponse of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeRecipientSharedView()
|
inline |
Provides a URL to start a shared recipient view of the Envelope UI Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - Embedded signing and sending - How to send an envelope via your app - How to embed the DocuSign UI in your app
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientViewRequest (optional)
- Returns
- ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeRecipientSharedViewAsync()
|
inline |
Provides a URL to start a shared recipient view of the Envelope UI Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - Embedded signing and sending - How to send an envelope via your app - How to embed the DocuSign UI in your app
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientViewRequest (optional)
- Returns
- Task of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeRecipientSharedViewAsyncWithHttpInfo()
|
inline |
Provides a URL to start a shared recipient view of the Envelope UI Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - Embedded signing and sending - How to send an envelope via your app - How to embed the DocuSign UI in your app
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientViewRequest (optional)
- Returns
- Task of ApiResponse (ViewUrl)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeRecipientSharedViewWithHttpInfo()
|
inline |
Provides a URL to start a shared recipient view of the Envelope UI Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. This is the view that a user sees of an envelope that a recipient on the same account has shared with them. Due to screen space issues, do not use an `<iframe>` for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView. ### Revoking the URL You can revoke this URL by making a DELETE HTTP request to the URL with no request body. ### Related topics - Embedded signing and sending - How to send an envelope via your app - How to embed the DocuSign UI in your app
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientViewRequest (optional)
- Returns
- ApiResponse of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeTransferRules()
|
inline |
Add envelope transfer rules to an account. This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleRequest (optional)
- Returns
- EnvelopeTransferRuleInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeTransferRulesAsync()
|
inline |
Add envelope transfer rules to an account. This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleRequest (optional)
- Returns
- Task of EnvelopeTransferRuleInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeTransferRulesAsyncWithHttpInfo()
|
inline |
Add envelope transfer rules to an account. This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleRequest (optional)
- Returns
- Task of ApiResponse (EnvelopeTransferRuleInformation)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeTransferRulesWithHttpInfo()
|
inline |
Add envelope transfer rules to an account. This method creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties: - `eventType` - `fromGroups` - `toUser` - `toFolder` - `carbonCopyOriginalOwner` - `enabled` Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleRequest (optional)
- Returns
- ApiResponse of EnvelopeTransferRuleInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeWithHttpInfo()
|
inline |
Creates an envelope. Creates an envelope. Using this function you can: * Create an envelope and send it. * Create an envelope from an existing template and send it. In either case, you can choose to save the envelope as a draft envelope instead of sending it by setting the request's `status` property to `created` instead of `sent`. ## Sending Envelopes Documents can be included with the Envelopes::create call itself or a template can include documents. Documents can be added by using a multi-part/form request or by using the `documentBase64` field of the `document` object ### Recipient Types An `envelopeDefinition` object is used as the method's body. Envelope recipients can be defined in the envelope or in templates. The `envelopeDefinition` object's `recipients` field is an `EnvelopeRecipients` resource object. It includes arrays of the seven types of recipients defined by DocuSign: Recipient type | Object definition - – – – – – – - | - – – – – – – – – agent (can add name and email information for later recipients/signers) | `agent` carbon copy (receives a copy of the documents) | `carbonCopy` certified delivery (receives a copy of the documents and must acknowledge receipt) | `certifiedDelivery` editor (can change recipients and document fields for later recipients/signers) | `editor` in-person signer ("hosts" someone who signs in-person) | `inPersonSigner` intermediary (can add name and email information for some later recipients/signers.) | `intermediary` signer (signs and/or updates document fields) | `signer` Additional information about the different types of recipients is available from the `EnvelopeRecipients` resource page and from the Developer Center ### Tabs Tabs (also referred to as `tags` and as `fields` in the web sending user interface), can be defined in the `envelopeDefinition`, in templates, by transforming PDF Form Fields, or by using Composite Templates (see below). Defining tabs: the `inPersonSigner`, and `signer` recipient objects include a `tabs` field. It is an `EnvelopeTabs` resource object. It includes arrays of the 24 different tab types available. See the `EnvelopeTabs` resource for more information. ## Using Templates Envelopes use specific people or groups as recipients. Templates can specify a role, eg `account_manager.` When a template is used in an envelope, the roles must be replaced with specific people or groups. When you create an envelope using a `templateId`, the different recipient type objects within the `EnvelopeRecipients` object are used to assign recipients to the template's roles via the `roleName` property. The recipient objects can also override settings that were specified in the template, and set values for tab fields that were defined in the template. ### Message Lock When a template is added or applied to an envelope and the template has a locked email subject and message, that subject and message are used for the envelope and cannot be changed even if another locked template is subsequently added or applied to the envelope. The field `messageLock` is used to lock the email subject and message. If an email subject or message is entered before adding or applying a template with `messageLock` true, the email subject and message is overwritten with the locked email subject and message from the template. ## Envelope Status The status of sent envelopes can be determined through the DocuSign webhook system or by polling. Webhooks are highly recommended: they provide your application with the quickest updates when an envelope's status changes. DocuSign limits polling to once every 15 minutes or less frequently. When a webhook is used, DocuSign calls your application, via the URL you provide, with a notification XML message. See the Webhook recipe for examples and live demos of using webhooks. ## Webhook Options The two webhook options, eventNotification and Connect use the same notification mechanism and message formats. eventNotification is used to create a webhook for a specific envelope sent via the API. Connect webhooks can be used for any envelope sent from an account, from any user, from any client. ### eventNotification Webhooks The Envelopes::create method includes an optional eventNotification object that adds a webhook to the envelope. eventNotification webhooks are available for all DocuSign accounts with API access. ### Connect Webhooks Connect can be used to create a webhook for all envelopes sent by all users in an account, either through the API or via other DocuSign clients (web, mobile, etc). Connect configurations are independent of specific envelopes. A Connect configuration includes a filter that may be used to limit the webhook to specific users, envelope statuses, etc. Connect configurations may be created and managed using the ConnectConfigurations resource. Configurations can also be created and managed from the Administration tool accessed by selecting "Go to Admin" from the menu next to your picture on the DocuSign web app. See the Integrations/Connect section of the Admin tool. For repeatability, and to minimize support questions, creating Connect configurations via the API is recommended, especially for ISVs. Connect is available for some DocuSign account types. Please contact DocuSign Sales for more information. ## Composite Templates The Composite Templates feature, like compositing in film production, enables you to overlay document, recipient, and tab definitions from multiple sources, including PDF Form Field definitions, templates defined on the server, and more. Each Composite Template consists of optional elements: server templates, inline templates, PDF Metadata templates, and documents. * The Composite Template ID is an optional element used to identify the composite template. It is used as a reference when adding document object information via a multi-part HTTP message. If used, the document content-disposition must include the `compositeTemplateId` to which the document should be added. If `compositeTemplateId` is not specified in the content-disposition, the document is applied based on the `documentId` only. If no document object is specified, the composite template inherits the first document. * Server Templates are server-side templates stored on the DocuSign platform. If supplied, they are overlaid into the envelope in the order of their Sequence value. * Inline Templates provide a container to add documents, recipients, tabs, and custom fields. If inline templates are supplied, they are overlaid into the envelope in the order of their Sequence value. * Document objects are optional structures that provide a container to pass in a document or form. If this object is not included, the composite template inherits the first document it finds from a server template or inline template, starting with the lowest sequence value. PDF Form objects are only transformed from the document object. DocuSign does not derive PDF form properties from server templates or inline templates. To instruct DocuSign to transform fields from the PDF form, set `transformPdfFields` to "true" for the document. See the Transform PDF Fields section for more information about process. * PDF Metadata Templates provide a container to embed design-time template information into a PDF document. DocuSign uses this information when processing the Envelope. This convention allows the document to carry the signing instructions with it, so that less information needs to be provided at run-time through an inline template or synchronized with an external structure like a server template. PDF Metadata templates are stored in the Metadata layer of a PDF in accordance with Acrobat's XMP specification. DocuSign will only find PDF Metadata templates inside documents passed in the Document object (see below). If supplied, the PDF metadata template will be overlaid into the envelope in the order of its Sequence value. ### Compositing the definitions Each Composite Template adds a new document and templates overlay into the envelope. For each Composite Template these rules are applied: * Templates are overlaid in the order of their Sequence value. * If Document is not passed into the Composite Template's `document` field, the first template's document (based on the template's Sequence value) is used. * Last in wins in all cases except for the document (i.e. envelope information, recipient information, secure field information). There is no special casing. For example, if you want higher security on a tab, then that needs to be specified in a later template (by sequence number) then where the tab is included. If you want higher security on a role recipient, then it needs to be in a later template then where that role recipient is specified. * Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all Composite Templates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order. * If you specify in a template that a recipient is locked, once that recipient is overlaid the recipient attributes can no longer be changed. The only items that can be changed for the recipient in this case are the email, username, access code and IDCheckInformationInput. * Tab matching is based on Tab Labels, Tab Types and Documents. If a Tab Label matches but the Document is not supplied, the Tab is overlaid for all the Documents. For example, if you have a simple inline template with only one tab in it with a label and a value, the Signature, Initial, Company, Envelope ID, User Name tabs will only be matched and collapsed if they fall in the exact same X and Y locations. * roleName and tabLabel matching is case sensitive. * The defaultRecipient field enables you to specify which recipient the generated tabs from a PDF form are mapped to. You can also set PDF form generated tabs to a recipient other than the DefaultRecipient by specifying the mapping of the tab label that is created to one of the template recipients. * You can use tabLabel wild carding to map a series of tabs from the PDF form. To use this you must end a tab label with "\*" and then the system matches tabs that start with the label. * If no DefaultRecipient is specified, tabs must be explicitly mapped to recipients in order to be generated from the form. Unmapped form objects will not be generated into their DocuSign equivalents. (In the case of Signature/Initials, the tabs will be disregarded entirely; in the case of pdf text fields, the field data will be flattened on the Envelope document, but there will not be a corresponding DocuSign data tab.) ### Including the Document Content for Composite Templates Document content can be supplied inline, using the `documentBase64` or can be included in a multi-part HTTP message. If a multi-part message is used and there are multiple Composite Templates, the document content-disposition can include the `compositeTemplateId` to which the document should be added. Using the `compositeTemplateId` sets which documents are associated with particular composite templates. An example of this usage is: ``` - -5cd3320a-5aac-4453-b3a4-cbb52a4cba5d Content-Type: application/pdf Content-Disposition: file; filename="eula.pdf"; documentId=1; compositeTemplateId="1" Content-Transfer-Encoding: base64 ``` ### PDF Form Field Transformation Only the following PDF Form FieldTypes will be transformed to DocuSign tabs: CheckBox, DateTime, ListBox, Numeric, Password, Radio, Signature, and Text Field Properties that will be transformed: Read Only, Required, Max Length, Positions, and Initial Data. When transforming a PDF Form Digital Signature Field, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials Any other PDF Form Digital Signature Field will be transformed to a DocuSign Signature tab When transforming PDF Form Text Fields, the following rules are used: If the PDF Field Name Contains | Then the DocuSign Tab Will be - – – – | - – – – - DocuSignSignHere or eSignSignHere | Signature DocuSignSignHereOptional or eSignSignHereOptional | Optional Signature DocuSignInitialHere or eSignInitialHere | Initials DocuSignInitialHereOptional or eSignInitialHereOptional | Optional Initials DocuSignEnvelopeID or eSignEnvelopeID | EnvelopeID DocuSignCompany or eSignCompany | Company DocuSignDateSigned or eSignDateSigned | Date Signed DocuSignTitle or eSignTitle | Title DocuSignFullName or eSignFullName | Full Name DocuSignSignerAttachmentOptional or eSignSignerAttachmentOptional | Optional Signer Attachment Any other PDF Form Text Field will be transformed to a DocuSign data (text) tab. PDF Form Field Names that include "DocuSignIgnoreTransform" or "eSignIgnoreTransform" will not be transformed. PDF Form Date fields will be transformed to Date Signed fields if their name includes DocuSignDateSigned or eSignDateSigned. ## Template Email Subject Merge Fields This feature enables you to insert recipient name and email address merge fields into the email subject line when creating or sending from a template. The merge fields, based on the recipient's `roleName`, are added to the `emailSubject` when the template is created or when the template is used to create an envelope. After a template sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to check the recipient. If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where the recipient name or email is expected to be long, you should consider placing the merge field at the start of the email subject. * To add a recipient's name in the subject line add the following text in the `emailSubject` when creating the template or when sending an envelope from a template: [[<roleName>_UserName]] Example: `"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",` * To add a recipient's email address in the subject line add the following text in the emailSubject when creating the template or when sending an envelope from a template: [[<roleName>_Email]] Example: `"emailSubject":"[[Signer 1_Email]], Please sign this NDA",` In both cases the <roleName> is the recipient's `roleName` in the template. For cases where another recipient (such as an Agent, Editor, or Intermediary recipient) is entering the name and email information for the recipient included in the email subject, then [[<roleName>_UserName]] or [[<roleName>_Email]] is shown in the email subject. ## Branding an envelope The following rules are used to determine the `brandId` used in an envelope: * If a `brandId` is specified in the envelope/template and that brandId is available to the account, that brand is used in the envelope. * If more than one template is used in an envelope and more than one `brandId` is specified, the first `brandId` specified is used throughout the envelope. * In cases where no brand is specified and the sender belongs to a Group; if there is only one brand associated with the Group, then that brand is used in the envelope. Otherwise, the account's default signing brand is used. * For envelopes that do not meet any of the previous criteria, the account's default signing brand is used for the envelope. ## BCC Email address feature The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, don't use the BCC Email field. Use a Carbon Copy or Certified Delivery Recipient type. ## Merge Recipient Roles for Draft Envelopes When an envelope with multiple templates is sent, the recipients from the templates are merged according to the template roles, and empty recipients are removed. When creating an envelope with multiple templates, but not sending it (keeping it in a created state), duplicate recipients are not merged, which could cause leave duplicate recipients in the envelope. To prevent this, the query parameter `merge_roles_on_draft` should be added when posting a draft envelope (status=created) with multiple templates. Doing this will merge template roles and remove empty recipients. ###### Note: DocuSign recommends that the `merge_roles_on_draft` query parameter be used anytime you are creating an envelope with multiple templates and keeping it in draft (created) status.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeDefinition (optional) options Options for modifying the behavior of the function.
- Returns
- ApiResponse of EnvelopeSummary
◆ CreateEnvelopeWorkflowStepDefinition()
|
inline |
Creates and adds a new workflow step definition for an envelope's workflow
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStep (optional)
- Returns
- WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeWorkflowStepDefinitionAsync()
|
inline |
Creates and adds a new workflow step definition for an envelope's workflow
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStep (optional)
- Returns
- Task of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeWorkflowStepDefinitionAsyncWithHttpInfo()
|
inline |
Creates and adds a new workflow step definition for an envelope's workflow
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStep (optional)
- Returns
- Task of ApiResponse (WorkflowStep)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateEnvelopeWorkflowStepDefinitionWithHttpInfo()
|
inline |
Creates and adds a new workflow step definition for an envelope's workflow
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStep (optional)
- Returns
- ApiResponse of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateHistoricalEnvelopePublishTransaction()
|
inline |
Submits a batch of historical envelopes for republish to an adhoc config.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. connectHistoricalEnvelopeRepublish (optional)
- Returns
- EnvelopePublishTransaction
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateHistoricalEnvelopePublishTransactionAsync()
|
inline |
Submits a batch of historical envelopes for republish to an adhoc config.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. connectHistoricalEnvelopeRepublish (optional)
- Returns
- Task of EnvelopePublishTransaction
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateHistoricalEnvelopePublishTransactionAsyncWithHttpInfo()
|
inline |
Submits a batch of historical envelopes for republish to an adhoc config.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. connectHistoricalEnvelopeRepublish (optional)
- Returns
- Task of ApiResponse (EnvelopePublishTransaction)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateHistoricalEnvelopePublishTransactionWithHttpInfo()
|
inline |
Submits a batch of historical envelopes for republish to an adhoc config.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. connectHistoricalEnvelopeRepublish (optional)
- Returns
- ApiResponse of EnvelopePublishTransaction
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateLock()
|
inline |
Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. lockRequest (optional)
- Returns
- LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateLockAsync()
|
inline |
Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. lockRequest (optional)
- Returns
- Task of LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateLockAsyncWithHttpInfo()
|
inline |
Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. lockRequest (optional)
- Returns
- Task of ApiResponse (LockInformation)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateLockWithHttpInfo()
|
inline |
Lock an envelope. Locks the specified envelope, and sets the time until the lock expires, to prevent other users or recipients from accessing and changing the envelope. ###### Note: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. lockRequest (optional)
- Returns
- ApiResponse of LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipient()
|
inline |
Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to true.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional) options Options for modifying the behavior of the function.
- Returns
- Recipients
◆ CreateRecipientAsync()
|
inline |
Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to true.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional) options Options for modifying the behavior of the function.
- Returns
- Task of Recipients
◆ CreateRecipientAsyncWithHttpInfo()
|
inline |
Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to true.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional) options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (Recipients)
◆ CreateRecipientManualReviewView()
|
inline |
Provides a link to access the Identity manual review related to a recipient. This method returns the URL of the page that allows a sender to manually review the ID of a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientManualReviewViewAsync()
|
inline |
Provides a link to access the Identity manual review related to a recipient. This method returns the URL of the page that allows a sender to manually review the ID of a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientManualReviewViewAsyncWithHttpInfo()
|
inline |
Provides a link to access the Identity manual review related to a recipient. This method returns the URL of the page that allows a sender to manually review the ID of a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of ApiResponse (ViewUrl)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientManualReviewViewWithHttpInfo()
|
inline |
Provides a link to access the Identity manual review related to a recipient. This method returns the URL of the page that allows a sender to manually review the ID of a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- ApiResponse of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientProofFileLink()
|
inline |
Returns a link to access to the identity events stored in the proof service related to this recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- IdEvidenceViewLink
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientProofFileLinkAsync()
|
inline |
Returns a link to access to the identity events stored in the proof service related to this recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of IdEvidenceViewLink
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientProofFileLinkAsyncWithHttpInfo()
|
inline |
Returns a link to access to the identity events stored in the proof service related to this recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of ApiResponse (IdEvidenceViewLink)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientProofFileLinkWithHttpInfo()
|
inline |
Returns a link to access to the identity events stored in the proof service related to this recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- ApiResponse of IdEvidenceViewLink
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientProofFileResourceToken()
|
inline |
Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
tokenScopes accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- IdEvidenceResourceToken
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientProofFileResourceTokenAsync()
|
inline |
Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
tokenScopes accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of IdEvidenceResourceToken
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientProofFileResourceTokenAsyncWithHttpInfo()
|
inline |
Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
tokenScopes accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of ApiResponse (IdEvidenceResourceToken)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientProofFileResourceTokenWithHttpInfo()
|
inline |
Returns a resource token to get access to the identity events stored in the proof service related to this recipient. Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
tokenScopes accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- ApiResponse of IdEvidenceResourceToken
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientView()
|
inline |
Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientViewRequest (optional)
- Returns
- ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientViewAsync()
|
inline |
Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientViewRequest (optional)
- Returns
- Task of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientViewAsyncWithHttpInfo()
|
inline |
Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientViewRequest (optional)
- Returns
- Task of ApiResponse (ViewUrl)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientViewWithHttpInfo()
|
inline |
Returns a URL to the recipient view UI. Returns a URL that allows you to embed the recipient view of the DocuSign UI in your applications. This call cannot be used to view draft envelopes, since those envelopes have not been sent. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView. An entry is added into the Security Level section of the DocuSign Certificate of Completion that reflects the `securityDomain` and `authenticationMethod` properties used to verify the user identity.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientViewRequest (optional)
- Returns
- ApiResponse of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateRecipientWithHttpInfo()
|
inline |
Adds one or more recipients to an envelope. Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient's routing order is before or the same as the envelope's next recipient, an email is only sent if the optional `resend_envelope` query string is set to true.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional) options Options for modifying the behavior of the function.
- Returns
- ApiResponse of Recipients
◆ CreateResponsiveHtmlPreview()
|
inline |
Get Responsive HTML Preview for all documents in an envelope. Creates a preview of the responsive, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentHtmlDefinition (optional)
- Returns
- DocumentHtmlDefinitions
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateResponsiveHtmlPreviewAsync()
|
inline |
Get Responsive HTML Preview for all documents in an envelope. Creates a preview of the responsive, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentHtmlDefinition (optional)
- Returns
- Task of DocumentHtmlDefinitions
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateResponsiveHtmlPreviewAsyncWithHttpInfo()
|
inline |
Get Responsive HTML Preview for all documents in an envelope. Creates a preview of the responsive, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentHtmlDefinition (optional)
- Returns
- Task of ApiResponse (DocumentHtmlDefinitions)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateResponsiveHtmlPreviewWithHttpInfo()
|
inline |
Get Responsive HTML Preview for all documents in an envelope. Creates a preview of the responsive, HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a `documentHtmlDefinition` object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentHtmlDefinition (optional)
- Returns
- ApiResponse of DocumentHtmlDefinitions
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateSenderView()
|
inline |
Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. returnUrlRequest (optional)
- Returns
- ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateSenderViewAsync()
|
inline |
Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. returnUrlRequest (optional)
- Returns
- Task of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateSenderViewAsyncWithHttpInfo()
|
inline |
Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. returnUrlRequest (optional)
- Returns
- Task of ApiResponse (ViewUrl)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateSenderViewWithHttpInfo()
|
inline |
Returns a URL to the sender view UI. Returns a URL that allows you to embed the sender view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign sending view. Upon sending completion, the user is returned to the return URL provided by the API application. Important: iFrames should not be used for embedded operations on mobile devices due to screen space issues. For iOS devices DocuSign recommends using a WebView.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. returnUrlRequest (optional)
- Returns
- ApiResponse of ViewUrl
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateTabs()
|
inline |
Adds tabs for a recipient. Adds one or more tabs for a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateTabsAsync()
|
inline |
Adds tabs for a recipient. Adds one or more tabs for a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- Task of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateTabsAsyncWithHttpInfo()
|
inline |
Adds tabs for a recipient. Adds one or more tabs for a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- Task of ApiResponse (Tabs)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateTabsWithHttpInfo()
|
inline |
Adds tabs for a recipient. Adds one or more tabs for a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- ApiResponse of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateTemplateWorkflowStepDefinition()
|
inline |
Creates and adds a new workflow step definition for a template's workflow
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStep (optional)
- Returns
- WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateTemplateWorkflowStepDefinitionAsync()
|
inline |
Creates and adds a new workflow step definition for a template's workflow
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStep (optional)
- Returns
- Task of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateTemplateWorkflowStepDefinitionAsyncWithHttpInfo()
|
inline |
Creates and adds a new workflow step definition for a template's workflow
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStep (optional)
- Returns
- Task of ApiResponse (WorkflowStep)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ CreateTemplateWorkflowStepDefinitionWithHttpInfo()
|
inline |
Creates and adds a new workflow step definition for a template's workflow
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStep (optional)
- Returns
- ApiResponse of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteAttachments()
|
inline |
Delete one or more attachments from a DRAFT envelope. Deletes one or more attachments from a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeAttachmentsRequest (optional)
- Returns
- EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteAttachmentsAsync()
|
inline |
Delete one or more attachments from a DRAFT envelope. Deletes one or more attachments from a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeAttachmentsRequest (optional)
- Returns
- Task of EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteAttachmentsAsyncWithHttpInfo()
|
inline |
Delete one or more attachments from a DRAFT envelope. Deletes one or more attachments from a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeAttachmentsRequest (optional)
- Returns
- Task of ApiResponse (EnvelopeAttachmentsResult)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteAttachmentsWithHttpInfo()
|
inline |
Delete one or more attachments from a DRAFT envelope. Deletes one or more attachments from a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeAttachmentsRequest (optional)
- Returns
- ApiResponse of EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteChunkedUpload()
|
inline |
Delete an existing ChunkedUpload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId
- Returns
- ChunkedUploadResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteChunkedUploadAsync()
|
inline |
Delete an existing ChunkedUpload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId
- Returns
- Task of ChunkedUploadResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteChunkedUploadAsyncWithHttpInfo()
|
inline |
Delete an existing ChunkedUpload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId
- Returns
- Task of ApiResponse (ChunkedUploadResponse)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteChunkedUploadWithHttpInfo()
|
inline |
Delete an existing ChunkedUpload. Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically: - Chunked uploads that have been consumed by use in another API call. - Expired chunked uploads. Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload will continue to count against your quota.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId
- Returns
- ApiResponse of ChunkedUploadResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteCustomFields()
|
inline |
Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- CustomFields
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteCustomFieldsAsync()
|
inline |
Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- Task of CustomFields
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteCustomFieldsAsyncWithHttpInfo()
|
inline |
Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- Task of ApiResponse (CustomFields)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteCustomFieldsWithHttpInfo()
|
inline |
Deletes envelope custom fields for draft and in-process envelopes. Deletes envelope custom fields for draft and in-process envelopes.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- ApiResponse of CustomFields
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentFields()
|
inline |
Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentFieldsAsync()
|
inline |
Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- Task of DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentFieldsAsyncWithHttpInfo()
|
inline |
Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- Task of ApiResponse (DocumentFieldsInformation)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentFieldsWithHttpInfo()
|
inline |
Deletes custom document fields from an existing envelope document. Deletes custom document fields from an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- ApiResponse of DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentPage()
|
inline |
Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed.
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentPageAsync()
|
inline |
Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed.
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentPageAsyncWithHttpInfo()
|
inline |
Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed.
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentPageWithHttpInfo()
|
inline |
Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed.
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocuments()
|
inline |
Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeDefinition (optional)
- Returns
- EnvelopeDocumentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentsAsync()
|
inline |
Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeDefinition (optional)
- Returns
- Task of EnvelopeDocumentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentsAsyncWithHttpInfo()
|
inline |
Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeDefinition (optional)
- Returns
- Task of ApiResponse (EnvelopeDocumentsResult)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentsWithHttpInfo()
|
inline |
Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeDefinition (optional)
- Returns
- ApiResponse of EnvelopeDocumentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentTabs()
|
inline |
Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentTabsAsync()
|
inline |
Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- Task of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentTabsAsyncWithHttpInfo()
|
inline |
Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- Task of ApiResponse (Tabs)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteDocumentTabsWithHttpInfo()
|
inline |
Deletes tabs from an envelope document Deletes tabs from the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- ApiResponse of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEmailSettings()
|
inline |
Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEmailSettingsAsync()
|
inline |
Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEmailSettingsAsyncWithHttpInfo()
|
inline |
Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (EmailSettings)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEmailSettingsWithHttpInfo()
|
inline |
Deletes the email setting overrides for an envelope. Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeCorrectView()
|
inline |
Revokes the correction view URL to the Envelope UI Revokes the correction view URL to the Envelope UI.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. correctViewRequest (optional)
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeCorrectViewAsync()
|
inline |
Revokes the correction view URL to the Envelope UI Revokes the correction view URL to the Envelope UI.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. correctViewRequest (optional)
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeCorrectViewAsyncWithHttpInfo()
|
inline |
Revokes the correction view URL to the Envelope UI Revokes the correction view URL to the Envelope UI.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. correctViewRequest (optional)
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeCorrectViewWithHttpInfo()
|
inline |
Revokes the correction view URL to the Envelope UI Revokes the correction view URL to the Envelope UI.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. correctViewRequest (optional)
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeDelayedRoutingDefinition()
|
inline |
Deletes the delayed routing rules for the specified envelope workflow step.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeDelayedRoutingDefinitionAsync()
|
inline |
Deletes the delayed routing rules for the specified envelope workflow step.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeDelayedRoutingDefinitionAsyncWithHttpInfo()
|
inline |
Deletes the delayed routing rules for the specified envelope workflow step.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeDelayedRoutingDefinitionWithHttpInfo()
|
inline |
Deletes the delayed routing rules for the specified envelope workflow step.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeScheduledSendingDefinition()
|
inline |
Deletes the scheduled sending rules for the envelope's workflow.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeScheduledSendingDefinitionAsync()
|
inline |
Deletes the scheduled sending rules for the envelope's workflow.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeScheduledSendingDefinitionAsyncWithHttpInfo()
|
inline |
Deletes the scheduled sending rules for the envelope's workflow.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeScheduledSendingDefinitionWithHttpInfo()
|
inline |
Deletes the scheduled sending rules for the envelope's workflow.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeTransferRules()
|
inline |
Delete envelope transfer rules for an account. This method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleId
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeTransferRulesAsync()
|
inline |
Delete envelope transfer rules for an account. This method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleId
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeTransferRulesAsyncWithHttpInfo()
|
inline |
Delete envelope transfer rules for an account. This method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleId
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeTransferRulesWithHttpInfo()
|
inline |
Delete envelope transfer rules for an account. This method deletes an envelope transfer rule. Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleId
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeWorkflowDefinition()
|
inline |
Delete the workflow definition for an envelope. Deletes the specified envelope's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeWorkflowDefinitionAsync()
|
inline |
Delete the workflow definition for an envelope. Deletes the specified envelope's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeWorkflowDefinitionAsyncWithHttpInfo()
|
inline |
Delete the workflow definition for an envelope. Deletes the specified envelope's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeWorkflowDefinitionWithHttpInfo()
|
inline |
Delete the workflow definition for an envelope. Deletes the specified envelope's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeWorkflowStepDefinition()
|
inline |
Deletes the envelope workflow step definition for an envelope's workflow by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeWorkflowStepDefinitionAsync()
|
inline |
Deletes the envelope workflow step definition for an envelope's workflow by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeWorkflowStepDefinitionAsyncWithHttpInfo()
|
inline |
Deletes the envelope workflow step definition for an envelope's workflow by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteEnvelopeWorkflowStepDefinitionWithHttpInfo()
|
inline |
Deletes the envelope workflow step definition for an envelope's workflow by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteLock()
|
inline |
Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteLockAsync()
|
inline |
Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteLockAsyncWithHttpInfo()
|
inline |
Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (LockInformation)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteLockWithHttpInfo()
|
inline |
Deletes an envelope lock. Deletes the lock from the specified envelope. The `X-DocuSign-Edit` header must be included in the request.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteRecipient()
|
inline |
Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Recipients
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteRecipientAsync()
|
inline |
Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of Recipients
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteRecipientAsyncWithHttpInfo()
|
inline |
Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of ApiResponse (Recipients)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteRecipients()
|
inline |
Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional)
- Returns
- Recipients
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteRecipientsAsync()
|
inline |
Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional)
- Returns
- Task of Recipients
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteRecipientsAsyncWithHttpInfo()
|
inline |
Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional)
- Returns
- Task of ApiResponse (Recipients)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteRecipientsWithHttpInfo()
|
inline |
Deletes recipients from an envelope. Deletes one or more recipients from a draft or sent envelope. Recipients to be deleted are listed in the request, with the `recipientId` being used as the key for deleting recipients. If the envelope is `In Process`, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional)
- Returns
- ApiResponse of Recipients
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteRecipientWithHttpInfo()
|
inline |
Deletes a recipient from an envelope. Deletes the specified recipient file from the specified envelope. This cannot be used if the envelope has been sent.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- ApiResponse of Recipients
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTabs()
|
inline |
Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTabsAsync()
|
inline |
Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- Task of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTabsAsyncWithHttpInfo()
|
inline |
Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- Task of ApiResponse (Tabs)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTabsWithHttpInfo()
|
inline |
Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- ApiResponse of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateDelayedRoutingDefinition()
|
inline |
Deletes the delayed routing rules for the specified template workflow step.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateDelayedRoutingDefinitionAsync()
|
inline |
Deletes the delayed routing rules for the specified template workflow step.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateDelayedRoutingDefinitionAsyncWithHttpInfo()
|
inline |
Deletes the delayed routing rules for the specified template workflow step.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateDelayedRoutingDefinitionWithHttpInfo()
|
inline |
Deletes the delayed routing rules for the specified template workflow step.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateScheduledSendingDefinition()
|
inline |
Deletes the scheduled sending rules for the template's workflow.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateScheduledSendingDefinitionAsync()
|
inline |
Deletes the scheduled sending rules for the template's workflow.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateScheduledSendingDefinitionAsyncWithHttpInfo()
|
inline |
Deletes the scheduled sending rules for the template's workflow.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateScheduledSendingDefinitionWithHttpInfo()
|
inline |
Deletes the scheduled sending rules for the template's workflow.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplatesFromDocument()
|
inline |
Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. templateId The ID of the template being accessed.
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplatesFromDocumentAsync()
|
inline |
Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. templateId The ID of the template being accessed.
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplatesFromDocumentAsyncWithHttpInfo()
|
inline |
Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. templateId The ID of the template being accessed.
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplatesFromDocumentWithHttpInfo()
|
inline |
Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. templateId The ID of the template being accessed.
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateWorkflowDefinition()
|
inline |
Delete the workflow definition for a template. Deletes the specified template's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateWorkflowDefinitionAsync()
|
inline |
Delete the workflow definition for a template. Deletes the specified template's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateWorkflowDefinitionAsyncWithHttpInfo()
|
inline |
Delete the workflow definition for a template. Deletes the specified template's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateWorkflowDefinitionWithHttpInfo()
|
inline |
Delete the workflow definition for a template. Deletes the specified template's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateWorkflowStepDefinition()
|
inline |
Deletes the workflow step definition for an template's workflow by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateWorkflowStepDefinitionAsync()
|
inline |
Deletes the workflow step definition for an template's workflow by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateWorkflowStepDefinitionAsyncWithHttpInfo()
|
inline |
Deletes the workflow step definition for an template's workflow by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ DeleteTemplateWorkflowStepDefinitionWithHttpInfo()
|
inline |
Deletes the workflow step definition for an template's workflow by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetAttachment()
|
inline |
Retrieves an attachment from the envelope. Retrieves an attachment from an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. attachmentId
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetAttachmentAsync()
|
inline |
Retrieves an attachment from the envelope. Retrieves an attachment from an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. attachmentId
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetAttachmentAsyncWithHttpInfo()
|
inline |
Retrieves an attachment from the envelope. Retrieves an attachment from an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. attachmentId
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetAttachments()
|
inline |
Returns a list of attachments associated with the specified envelope Returns a list of attachments associated with a specified envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetAttachmentsAsync()
|
inline |
Returns a list of attachments associated with the specified envelope Returns a list of attachments associated with a specified envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetAttachmentsAsyncWithHttpInfo()
|
inline |
Returns a list of attachments associated with the specified envelope Returns a list of attachments associated with a specified envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (EnvelopeAttachmentsResult)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetAttachmentsWithHttpInfo()
|
inline |
Returns a list of attachments associated with the specified envelope Returns a list of attachments associated with a specified envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetAttachmentWithHttpInfo()
|
inline |
Retrieves an attachment from the envelope. Retrieves an attachment from an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. attachmentId
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetBasePath()
|
inline |
◆ GetChunkedUpload()
|
inline |
Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId options Options for modifying the behavior of the function.
- Returns
- ChunkedUploadResponse
◆ GetChunkedUploadAsync()
|
inline |
Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId options Options for modifying the behavior of the function.
- Returns
- Task of ChunkedUploadResponse
◆ GetChunkedUploadAsyncWithHttpInfo()
|
inline |
Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (ChunkedUploadResponse)
◆ GetChunkedUploadWithHttpInfo()
|
inline |
Retrieves the current metadata of a ChunkedUpload. Returns the details (but not the content) about a chunked upload. Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId options Options for modifying the behavior of the function.
- Returns
- ApiResponse of ChunkedUploadResponse
◆ GetCommentsTranscript()
|
inline |
Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- System.IO.Stream
◆ GetCommentsTranscriptAsync()
|
inline |
Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of System.IO.Stream
◆ GetCommentsTranscriptAsyncWithHttpInfo()
|
inline |
Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (System.IO.Stream)
◆ GetCommentsTranscriptWithHttpInfo()
|
inline |
Gets comment transcript for envelope and user Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the `accountSettingsInformation` object, set the `enableSigningExtensionComments` property to true).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of System.IO.Stream
◆ GetConsumerDisclosure()
|
inline |
Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. options Options for modifying the behavior of the function.
- Returns
- ConsumerDisclosure
◆ GetConsumerDisclosureAsync()
|
inline |
Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. options Options for modifying the behavior of the function.
- Returns
- Task of ConsumerDisclosure
◆ GetConsumerDisclosureAsyncWithHttpInfo()
|
inline |
Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (ConsumerDisclosure)
◆ GetConsumerDisclosureDefault()
|
inline |
Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- ConsumerDisclosure
◆ GetConsumerDisclosureDefaultAsync()
|
inline |
Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ConsumerDisclosure
◆ GetConsumerDisclosureDefaultAsyncWithHttpInfo()
|
inline |
Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (ConsumerDisclosure)
◆ GetConsumerDisclosureDefaultWithHttpInfo()
|
inline |
Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of ConsumerDisclosure
◆ GetConsumerDisclosureWithHttpInfo()
|
inline |
Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. langCode The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), Armenian (hy), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of ConsumerDisclosure
◆ GetDocument()
|
inline |
Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- System.IO.Stream
◆ GetDocumentAsync()
|
inline |
Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of System.IO.Stream
◆ GetDocumentAsyncWithHttpInfo()
|
inline |
Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (System.IO.Stream)
◆ GetDocumentPageImage()
|
inline |
Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed. options Options for modifying the behavior of the function.
- Returns
- System.IO.Stream
◆ GetDocumentPageImageAsync()
|
inline |
Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of System.IO.Stream
◆ GetDocumentPageImageAsyncWithHttpInfo()
|
inline |
Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (System.IO.Stream)
◆ GetDocumentPageImageWithHttpInfo()
|
inline |
Gets a page image from an envelope for display. Retrieves a page image for display from the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of System.IO.Stream
◆ GetDocumentTabs()
|
inline |
Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- Tabs
◆ GetDocumentTabsAsync()
|
inline |
Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of Tabs
◆ GetDocumentTabsAsyncWithHttpInfo()
|
inline |
Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (Tabs)
◆ GetDocumentTabsWithHttpInfo()
|
inline |
Returns tabs on the document. Returns the tabs on the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of Tabs
◆ GetDocumentWithHttpInfo()
|
inline |
Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. You can also use this method to retrieve a PDF containing the combined content of all documents and the certificate. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. To retrieve the combined content replace the `{documentId}` parameter in the endpoint with `combined`. /accounts/{accountId}/envelopes/{envelopeId}/documents/combined
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of System.IO.Stream
◆ GetEmailSettings()
|
inline |
Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEmailSettingsAsync()
|
inline |
Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEmailSettingsAsyncWithHttpInfo()
|
inline |
Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (EmailSettings)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEmailSettingsWithHttpInfo()
|
inline |
Gets the email setting overrides for an envelope. Retrieves the email override settings for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelope()
|
inline |
Gets the status of a envelope. Retrieves the overall status for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Envelope
◆ GetEnvelopeAsync()
|
inline |
Gets the status of a envelope. Retrieves the overall status for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of Envelope
◆ GetEnvelopeAsyncWithHttpInfo()
|
inline |
Gets the status of a envelope. Retrieves the overall status for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (Envelope)
◆ GetEnvelopeDelayedRoutingDefinition()
|
inline |
Returns the delayed routing rules for an envelope's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDelayedRoutingDefinitionAsync()
|
inline |
Returns the delayed routing rules for an envelope's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- Task of DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDelayedRoutingDefinitionAsyncWithHttpInfo()
|
inline |
Returns the delayed routing rules for an envelope's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- Task of ApiResponse (DelayedRouting)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDelayedRoutingDefinitionWithHttpInfo()
|
inline |
Returns the delayed routing rules for an envelope's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- ApiResponse of DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDocGenFormFields()
|
inline |
Returns formfields for an envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- DocGenFormFieldResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDocGenFormFieldsAsync()
|
inline |
Returns formfields for an envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of DocGenFormFieldResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDocGenFormFieldsAsyncWithHttpInfo()
|
inline |
Returns formfields for an envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (DocGenFormFieldResponse)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDocGenFormFieldsWithHttpInfo()
|
inline |
Returns formfields for an envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of DocGenFormFieldResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDocumentHtmlDefinitions()
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for a given document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed.
- Returns
- DocumentHtmlDefinitionOriginals
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDocumentHtmlDefinitionsAsync()
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for a given document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed.
- Returns
- Task of DocumentHtmlDefinitionOriginals
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDocumentHtmlDefinitionsAsyncWithHttpInfo()
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for a given document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed.
- Returns
- Task of ApiResponse (DocumentHtmlDefinitionOriginals)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeDocumentHtmlDefinitionsWithHttpInfo()
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for a given document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed.
- Returns
- ApiResponse of DocumentHtmlDefinitionOriginals
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeHtmlDefinitions()
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- DocumentHtmlDefinitionOriginals
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeHtmlDefinitionsAsync()
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of DocumentHtmlDefinitionOriginals
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeHtmlDefinitionsAsyncWithHttpInfo()
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (DocumentHtmlDefinitionOriginals)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeHtmlDefinitionsWithHttpInfo()
|
inline |
Get the Original HTML Definition used to generate the Responsive HTML for the envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of DocumentHtmlDefinitionOriginals
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeScheduledSendingDefinition()
|
inline |
Returns the scheduled sending rules for an envelope's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeScheduledSendingDefinitionAsync()
|
inline |
Returns the scheduled sending rules for an envelope's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeScheduledSendingDefinitionAsyncWithHttpInfo()
|
inline |
Returns the scheduled sending rules for an envelope's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (ScheduledSending)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeScheduledSendingDefinitionWithHttpInfo()
|
inline |
Returns the scheduled sending rules for an envelope's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeTransferRules()
|
inline |
Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- EnvelopeTransferRuleInformation
◆ GetEnvelopeTransferRulesAsync()
|
inline |
Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- Task of EnvelopeTransferRuleInformation
◆ GetEnvelopeTransferRulesAsyncWithHttpInfo()
|
inline |
Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (EnvelopeTransferRuleInformation)
◆ GetEnvelopeTransferRulesWithHttpInfo()
|
inline |
Returns a list of envelope transfer rules in the specified account. This method retrieves a list of envelope transfer rules associated with an account. Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of EnvelopeTransferRuleInformation
◆ GetEnvelopeWithHttpInfo()
|
inline |
Gets the status of a envelope. Retrieves the overall status for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of Envelope
◆ GetEnvelopeWorkflowDefinition()
|
inline |
Returns the workflow definition for an envelope. Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeWorkflowDefinitionAsync()
|
inline |
Returns the workflow definition for an envelope. Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeWorkflowDefinitionAsyncWithHttpInfo()
|
inline |
Returns the workflow definition for an envelope. Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (Workflow)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeWorkflowDefinitionWithHttpInfo()
|
inline |
Returns the workflow definition for an envelope. Returns an envelope's workflow definition if the envelope specified by `envelopeId` has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeWorkflowStepDefinition()
|
inline |
Returns the workflow step definition for an envelope by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeWorkflowStepDefinitionAsync()
|
inline |
Returns the workflow step definition for an envelope by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- Task of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeWorkflowStepDefinitionAsyncWithHttpInfo()
|
inline |
Returns the workflow step definition for an envelope by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- Task of ApiResponse (WorkflowStep)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetEnvelopeWorkflowStepDefinitionWithHttpInfo()
|
inline |
Returns the workflow step definition for an envelope by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId
- Returns
- ApiResponse of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetFormData()
|
inline |
Returns envelope form data for an existing envelope. This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account. ### Related topics - How to get envelope tab values
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- EnvelopeFormData
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetFormDataAsync()
|
inline |
Returns envelope form data for an existing envelope. This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account. ### Related topics - How to get envelope tab values
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of EnvelopeFormData
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetFormDataAsyncWithHttpInfo()
|
inline |
Returns envelope form data for an existing envelope. This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account. ### Related topics - How to get envelope tab values
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (EnvelopeFormData)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetFormDataWithHttpInfo()
|
inline |
Returns envelope form data for an existing envelope. This method downloads the envelope and tab data (also called form data) from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them. Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account. ### Related topics - How to get envelope tab values
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of EnvelopeFormData
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetLock()
|
inline |
Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetLockAsync()
|
inline |
Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetLockAsyncWithHttpInfo()
|
inline |
Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (LockInformation)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetLockWithHttpInfo()
|
inline |
Gets envelope lock information. Retrieves general information about the envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the `X-DocuSign-Edit` header and additional lock information is included in the response. This allows users to recover a lost editing session token and the `X-DocuSign-Edit` header.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetNotificationSettings()
|
inline |
Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Notification
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetNotificationSettingsAsync()
|
inline |
Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of Notification
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetNotificationSettingsAsyncWithHttpInfo()
|
inline |
Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (Notification)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetNotificationSettingsWithHttpInfo()
|
inline |
Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of Notification
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetPages()
|
inline |
Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- PageImages
◆ GetPagesAsync()
|
inline |
Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of PageImages
◆ GetPagesAsyncWithHttpInfo()
|
inline |
Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (PageImages)
◆ GetPagesWithHttpInfo()
|
inline |
Returns document page image(s) based on input. Returns images of the pages in a document for display based on the parameters that you specify.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of PageImages
◆ GetPageTabs()
|
inline |
Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed.
- Returns
- Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetPageTabsAsync()
|
inline |
Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed.
- Returns
- Task of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetPageTabsAsyncWithHttpInfo()
|
inline |
Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed.
- Returns
- Task of ApiResponse (Tabs)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetPageTabsWithHttpInfo()
|
inline |
Returns tabs on the specified page. Returns the tabs from the page specified by `pageNumber` of the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed.
- Returns
- ApiResponse of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetRecipientDocumentVisibility()
|
inline |
Returns document visibility for the recipients This method returns information about document visibility for a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetRecipientDocumentVisibilityAsync()
|
inline |
Returns document visibility for the recipients This method returns information about document visibility for a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetRecipientDocumentVisibilityAsyncWithHttpInfo()
|
inline |
Returns document visibility for the recipients This method returns information about document visibility for a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of ApiResponse (DocumentVisibilityList)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetRecipientDocumentVisibilityWithHttpInfo()
|
inline |
Returns document visibility for the recipients This method returns information about document visibility for a recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- ApiResponse of DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetRecipientInitialsImage()
|
inline |
Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- System.IO.Stream
◆ GetRecipientInitialsImageAsync()
|
inline |
Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of System.IO.Stream
◆ GetRecipientInitialsImageAsyncWithHttpInfo()
|
inline |
Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (System.IO.Stream)
◆ GetRecipientInitialsImageWithHttpInfo()
|
inline |
Gets the initials image for a user. Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user id and the user must be a member of the account. The `signatureIdOrName` paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of System.IO.Stream
◆ GetRecipientSignature()
|
inline |
Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- UserSignature
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetRecipientSignatureAsync()
|
inline |
Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of UserSignature
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetRecipientSignatureAsyncWithHttpInfo()
|
inline |
Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of ApiResponse (UserSignature)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetRecipientSignatureImage()
|
inline |
Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- System.IO.Stream
◆ GetRecipientSignatureImageAsync()
|
inline |
Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of System.IO.Stream
◆ GetRecipientSignatureImageAsyncWithHttpInfo()
|
inline |
Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (System.IO.Stream)
◆ GetRecipientSignatureImageWithHttpInfo()
|
inline |
Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user's user ID and the user must be a member of the account. The `signatureIdOrName` parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that don't properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of System.IO.Stream
◆ GetRecipientSignatureWithHttpInfo()
|
inline |
Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- ApiResponse of UserSignature
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTabsBlob()
|
inline |
Get encrypted tabs for envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTabsBlobAsync()
|
inline |
Get encrypted tabs for envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTabsBlobAsyncWithHttpInfo()
|
inline |
Get encrypted tabs for envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTabsBlobWithHttpInfo()
|
inline |
Get encrypted tabs for envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateDelayedRoutingDefinition()
|
inline |
Returns the delayed routing rules for a template's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateDelayedRoutingDefinitionAsync()
|
inline |
Returns the delayed routing rules for a template's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- Task of DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateDelayedRoutingDefinitionAsyncWithHttpInfo()
|
inline |
Returns the delayed routing rules for a template's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- Task of ApiResponse (DelayedRouting)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateDelayedRoutingDefinitionWithHttpInfo()
|
inline |
Returns the delayed routing rules for a template's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- ApiResponse of DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateRecipientDocumentVisibility()
|
inline |
Returns document visibility for the recipients This method returns information about document visibility for a template recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. recipientId The ID of the recipient being accessed.
- Returns
- DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateRecipientDocumentVisibilityAsync()
|
inline |
Returns document visibility for the recipients This method returns information about document visibility for a template recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateRecipientDocumentVisibilityAsyncWithHttpInfo()
|
inline |
Returns document visibility for the recipients This method returns information about document visibility for a template recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of ApiResponse (DocumentVisibilityList)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateRecipientDocumentVisibilityWithHttpInfo()
|
inline |
Returns document visibility for the recipients This method returns information about document visibility for a template recipient.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. recipientId The ID of the recipient being accessed.
- Returns
- ApiResponse of DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateScheduledSendingDefinition()
|
inline |
Returns the scheduled sending rules for a template's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateScheduledSendingDefinitionAsync()
|
inline |
Returns the scheduled sending rules for a template's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- Task of ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateScheduledSendingDefinitionAsyncWithHttpInfo()
|
inline |
Returns the scheduled sending rules for a template's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- Task of ApiResponse (ScheduledSending)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateScheduledSendingDefinitionWithHttpInfo()
|
inline |
Returns the scheduled sending rules for a template's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- ApiResponse of ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateWorkflowDefinition()
|
inline |
Returns the workflow definition for a template. Returns template's workflow definition if the template specified by `templateId` has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateWorkflowDefinitionAsync()
|
inline |
Returns the workflow definition for a template. Returns template's workflow definition if the template specified by `templateId` has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- Task of Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateWorkflowDefinitionAsyncWithHttpInfo()
|
inline |
Returns the workflow definition for a template. Returns template's workflow definition if the template specified by `templateId` has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- Task of ApiResponse (Workflow)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateWorkflowDefinitionWithHttpInfo()
|
inline |
Returns the workflow definition for a template. Returns template's workflow definition if the template specified by `templateId` has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed.
- Returns
- ApiResponse of Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateWorkflowStepDefinition()
|
inline |
Returns the workflow step definition for a template by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateWorkflowStepDefinitionAsync()
|
inline |
Returns the workflow step definition for a template by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- Task of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateWorkflowStepDefinitionAsyncWithHttpInfo()
|
inline |
Returns the workflow step definition for a template by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- Task of ApiResponse (WorkflowStep)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ GetTemplateWorkflowStepDefinitionWithHttpInfo()
|
inline |
Returns the workflow step definition for a template by step id.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId
- Returns
- ApiResponse of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListAuditEvents()
|
inline |
Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- EnvelopeAuditEventResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListAuditEventsAsync()
|
inline |
Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of EnvelopeAuditEventResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListAuditEventsAsyncWithHttpInfo()
|
inline |
Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (EnvelopeAuditEventResponse)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListAuditEventsWithHttpInfo()
|
inline |
Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of EnvelopeAuditEventResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListCustomFields()
|
inline |
Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- CustomFieldsEnvelope
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListCustomFieldsAsync()
|
inline |
Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of CustomFieldsEnvelope
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListCustomFieldsAsyncWithHttpInfo()
|
inline |
Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse (CustomFieldsEnvelope)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListCustomFieldsWithHttpInfo()
|
inline |
Gets the custom field information for the specified envelope. Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a pre-made list.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of CustomFieldsEnvelope
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListDocumentFields()
|
inline |
Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed.
- Returns
- DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListDocumentFieldsAsync()
|
inline |
Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed.
- Returns
- Task of DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListDocumentFieldsAsyncWithHttpInfo()
|
inline |
Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed.
- Returns
- Task of ApiResponse (DocumentFieldsInformation)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListDocumentFieldsWithHttpInfo()
|
inline |
Gets the custom document fields from an existing envelope document. Retrieves the custom document field information from an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed.
- Returns
- ApiResponse of DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ ListDocuments()
|
inline |
Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- EnvelopeDocumentsResult
◆ ListDocumentsAsync()
|
inline |
Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of EnvelopeDocumentsResult
◆ ListDocumentsAsyncWithHttpInfo()
|
inline |
Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (EnvelopeDocumentsResult)
◆ ListDocumentsWithHttpInfo()
|
inline |
Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of EnvelopeDocumentsResult
◆ ListRecipients()
|
inline |
Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Recipients
◆ ListRecipientsAsync()
|
inline |
Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of Recipients
◆ ListRecipientsAsyncWithHttpInfo()
|
inline |
Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (Recipients)
◆ ListRecipientsWithHttpInfo()
|
inline |
Gets the status of recipients for an envelope. Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. The `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of Recipients
◆ ListStatus()
|
inline |
Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeIdsRequest (optional) options Options for modifying the behavior of the function.
- Returns
- EnvelopesInformation
◆ ListStatusAsync()
|
inline |
Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeIdsRequest (optional) options Options for modifying the behavior of the function.
- Returns
- Task of EnvelopesInformation
◆ ListStatusAsyncWithHttpInfo()
|
inline |
Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeIdsRequest (optional) options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (EnvelopesInformation)
◆ ListStatusChanges()
|
inline |
Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- EnvelopesInformation
◆ ListStatusChangesAsync()
|
inline |
Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- Task of EnvelopesInformation
◆ ListStatusChangesAsyncWithHttpInfo()
|
inline |
Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (EnvelopesInformation)
◆ ListStatusChangesWithHttpInfo()
|
inline |
Gets status changes for one or more envelopes. Retrieves envelope status changes for all envelopes. You can modify the information returned by adding query strings to limit the request to check between certain dates and times, or for certain envelopes, or for certain status codes. It is recommended that you use one or more of the query strings in order to limit the size of the response. ### Important: Unless you are requesting the status for specific envelopes (using the `envelopeIds` or `transactionIds` properties), you must add a set the `from_date` property in the request. Getting envelope status using `transactionIds` is useful for offline signing situations where it can be used determine if an envelope was created or not, for the cases where a network connection was lost, before the envelope status could be returned. ### Request Envelope Status Notes ### The REST API GET /envelopes call uses certain filters to find results. In some cases requests are check for "any status change" instead of the just the single status requested. In these cases, more envelopes might be returned by the request than otherwise would be. For example, for a request with the begin date is set to Jan 1st, an end date set to Jan 7th and the status qualifier (`from_to_status`) set to `Delivered` — the response set might contain envelopes that were created during that time period, but not delivered during the time period. To avoid unnecessary database queries, the DocuSign system checks requests to ensure that the added filters will not result in a zero-size response before acting on the request. The following table shows the valid envelope statuses (in the Valid Current Statuses column) for the status qualifiers in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the valid current statuses column, then an empty list is returned. For example, a request with a status qualifier (from_to_status) of `Delivered` and a status of "`Created`,`Sent`", DocuSign will always return an empty list. This is because the request essentially translates to: find the envelopes that were delivered between the begin and end dates that have a current status of `Created` or `Sent`, and since an envelope that has been delivered can never have a status of `Created` or `Sent`, a zero-size response would be generated. In this case, DocuSign does not run the request, but just returns the empty list. Client applications should check that the statuses they are requesting make sense for a given status qualifier.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of EnvelopesInformation
◆ ListStatusWithHttpInfo()
|
inline |
Gets the envelope status for the specified envelopes. Retrieves the envelope status for the specified envelopes.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeIdsRequest (optional) options Options for modifying the behavior of the function.
- Returns
- ApiResponse of EnvelopesInformation
◆ ListTabs()
|
inline |
Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- Tabs
◆ ListTabsAsync()
|
inline |
Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of Tabs
◆ ListTabsAsyncWithHttpInfo()
|
inline |
Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (Tabs)
◆ ListTabsWithHttpInfo()
|
inline |
Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of Tabs
◆ ListTemplates()
|
inline |
Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- TemplateInformation
◆ ListTemplatesAsync()
|
inline |
Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of TemplateInformation
◆ ListTemplatesAsyncWithHttpInfo()
|
inline |
Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (TemplateInformation)
◆ ListTemplatesForDocument()
|
inline |
Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- TemplateInformation
◆ ListTemplatesForDocumentAsync()
|
inline |
Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of TemplateInformation
◆ ListTemplatesForDocumentAsyncWithHttpInfo()
|
inline |
Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (TemplateInformation)
◆ ListTemplatesForDocumentWithHttpInfo()
|
inline |
Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of TemplateInformation
◆ ListTemplatesWithHttpInfo()
|
inline |
Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. options Options for modifying the behavior of the function.
- Returns
- ApiResponse of TemplateInformation
◆ PutAttachment()
|
inline |
Add an attachment to a DRAFT or IN-PROCESS envelope. Adds an attachment to a draft or in-process envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. attachmentId attachment (optional)
- Returns
- EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ PutAttachmentAsync()
|
inline |
Add an attachment to a DRAFT or IN-PROCESS envelope. Adds an attachment to a draft or in-process envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. attachmentId attachment (optional)
- Returns
- Task of EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ PutAttachmentAsyncWithHttpInfo()
|
inline |
Add an attachment to a DRAFT or IN-PROCESS envelope. Adds an attachment to a draft or in-process envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. attachmentId attachment (optional)
- Returns
- Task of ApiResponse (EnvelopeAttachmentsResult)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ PutAttachments()
|
inline |
Add one or more attachments to a DRAFT or IN-PROCESS envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see Supported File Formats.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeAttachmentsRequest (optional)
- Returns
- EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ PutAttachmentsAsync()
|
inline |
Add one or more attachments to a DRAFT or IN-PROCESS envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see Supported File Formats.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeAttachmentsRequest (optional)
- Returns
- Task of EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ PutAttachmentsAsyncWithHttpInfo()
|
inline |
Add one or more attachments to a DRAFT or IN-PROCESS envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see Supported File Formats.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeAttachmentsRequest (optional)
- Returns
- Task of ApiResponse (EnvelopeAttachmentsResult)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ PutAttachmentsWithHttpInfo()
|
inline |
Add one or more attachments to a DRAFT or IN-PROCESS envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see Supported File Formats.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeAttachmentsRequest (optional)
- Returns
- ApiResponse of EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ PutAttachmentWithHttpInfo()
|
inline |
Add an attachment to a DRAFT or IN-PROCESS envelope. Adds an attachment to a draft or in-process envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. attachmentId attachment (optional)
- Returns
- ApiResponse of EnvelopeAttachmentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ RotateDocumentPage()
|
inline |
Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed. pageRequest (optional)
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ RotateDocumentPageAsync()
|
inline |
Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed. pageRequest (optional)
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ RotateDocumentPageAsyncWithHttpInfo()
|
inline |
Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed. pageRequest (optional)
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ RotateDocumentPageWithHttpInfo()
|
inline |
Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. pageNumber The page number being accessed. pageRequest (optional)
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ Update()
|
inline |
Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {"status":"sent"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {"purgeState":"purge type"} to the request body. Additional information on purging documents The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelope (optional) options Options for modifying the behavior of the function.
- Returns
- EnvelopeUpdateSummary
◆ UpdateAsync()
|
inline |
Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {"status":"sent"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {"purgeState":"purge type"} to the request body. Additional information on purging documents The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelope (optional) options Options for modifying the behavior of the function.
- Returns
- Task of EnvelopeUpdateSummary
◆ UpdateAsyncWithHttpInfo()
|
inline |
Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {"status":"sent"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {"purgeState":"purge type"} to the request body. Additional information on purging documents The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelope (optional) options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (EnvelopeUpdateSummary)
◆ UpdateChunkedUpload()
|
inline |
Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId options Options for modifying the behavior of the function.
- Returns
- ChunkedUploadResponse
◆ UpdateChunkedUploadAsync()
|
inline |
Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId options Options for modifying the behavior of the function.
- Returns
- Task of ChunkedUploadResponse
◆ UpdateChunkedUploadAsyncWithHttpInfo()
|
inline |
Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (ChunkedUploadResponse)
◆ UpdateChunkedUploadPart()
|
inline |
Add a chunk, a chunk 'part', to an existing ChunkedUpload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId chunkedUploadPartSeq chunkedUploadRequest (optional)
- Returns
- ChunkedUploadResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateChunkedUploadPartAsync()
|
inline |
Add a chunk, a chunk 'part', to an existing ChunkedUpload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId chunkedUploadPartSeq chunkedUploadRequest (optional)
- Returns
- Task of ChunkedUploadResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateChunkedUploadPartAsyncWithHttpInfo()
|
inline |
Add a chunk, a chunk 'part', to an existing ChunkedUpload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId chunkedUploadPartSeq chunkedUploadRequest (optional)
- Returns
- Task of ApiResponse (ChunkedUploadResponse)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateChunkedUploadPartWithHttpInfo()
|
inline |
Add a chunk, a chunk 'part', to an existing ChunkedUpload. Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign. Example: ``` PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3 ``` Note: You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId chunkedUploadPartSeq chunkedUploadRequest (optional)
- Returns
- ApiResponse of ChunkedUploadResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateChunkedUploadWithHttpInfo()
|
inline |
Integrity-Check and Commit a ChunkedUpload, readying it for use elsewhere. This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method. Note: After you commit a chunked upload, it no longer accepts additional parts.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. chunkedUploadId options Options for modifying the behavior of the function.
- Returns
- ApiResponse of ChunkedUploadResponse
◆ UpdateCustomFields()
|
inline |
Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- CustomFields
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateCustomFieldsAsync()
|
inline |
Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- Task of CustomFields
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateCustomFieldsAsyncWithHttpInfo()
|
inline |
Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- Task of ApiResponse (CustomFields)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateCustomFieldsWithHttpInfo()
|
inline |
Updates envelope custom fields in an envelope. Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. customFields (optional)
- Returns
- ApiResponse of CustomFields
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocument()
|
inline |
Adds a document to an existing draft envelope. Adds a document to an existing draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFileBytes Updated document content.
- Returns
- EnvelopeDocument
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentAsync()
|
inline |
Adds a document to an existing draft envelope. Adds a document to an existing draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFileBytes Updated document content.
- Returns
- Task of EnvelopeDocument
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentAsyncWithHttpInfo()
|
inline |
Adds a document to an existing draft envelope. Adds a document to an existing draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFileBytes Updated document content.
- Returns
- Task of ApiResponse (EnvelopeDocument)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentFields()
|
inline |
Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentFieldsAsync()
|
inline |
Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- Task of DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentFieldsAsyncWithHttpInfo()
|
inline |
Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- Task of ApiResponse (DocumentFieldsInformation)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentFieldsWithHttpInfo()
|
inline |
Updates existing custom document fields in an existing envelope document. Updates existing custom document fields in an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFieldsInformation (optional)
- Returns
- ApiResponse of DocumentFieldsInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocuments()
|
inline |
Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeDefinition (optional)
- Returns
- EnvelopeDocumentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentsAsync()
|
inline |
Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeDefinition (optional)
- Returns
- Task of EnvelopeDocumentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentsAsyncWithHttpInfo()
|
inline |
Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeDefinition (optional)
- Returns
- Task of ApiResponse (EnvelopeDocumentsResult)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentsWithHttpInfo()
|
inline |
Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeDefinition (optional)
- Returns
- ApiResponse of EnvelopeDocumentsResult
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentTabs()
|
inline |
Updates the tabs for an envelope document Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentTabsAsync()
|
inline |
Updates the tabs for an envelope document Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- Task of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentTabsAsyncWithHttpInfo()
|
inline |
Updates the tabs for an envelope document Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- Task of ApiResponse (Tabs)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentTabsWithHttpInfo()
|
inline |
Updates the tabs for an envelope document Updates tabs in the document specified by `documentId` in the envelope specified by `envelopeId`.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. tabs (optional)
- Returns
- ApiResponse of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateDocumentWithHttpInfo()
|
inline |
Adds a document to an existing draft envelope. Adds a document to an existing draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentId The ID of the document being accessed. documentFileBytes Updated document content.
- Returns
- ApiResponse of EnvelopeDocument
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEmailSettings()
|
inline |
Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. emailSettings (optional)
- Returns
- EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEmailSettingsAsync()
|
inline |
Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. emailSettings (optional)
- Returns
- Task of EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEmailSettingsAsyncWithHttpInfo()
|
inline |
Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. emailSettings (optional)
- Returns
- Task of ApiResponse (EmailSettings)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEmailSettingsWithHttpInfo()
|
inline |
Updates the email setting overrides for an envelope. Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. emailSettings (optional)
- Returns
- ApiResponse of EmailSettings
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeDelayedRoutingDefinition()
|
inline |
Updates the delayed routing rules for an envelope's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId delayedRouting (optional)
- Returns
- DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeDelayedRoutingDefinitionAsync()
|
inline |
Updates the delayed routing rules for an envelope's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId delayedRouting (optional)
- Returns
- Task of DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeDelayedRoutingDefinitionAsyncWithHttpInfo()
|
inline |
Updates the delayed routing rules for an envelope's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId delayedRouting (optional)
- Returns
- Task of ApiResponse (DelayedRouting)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeDelayedRoutingDefinitionWithHttpInfo()
|
inline |
Updates the delayed routing rules for an envelope's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId delayedRouting (optional)
- Returns
- ApiResponse of DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeDocGenFormFields()
|
inline |
Updates formfields for an envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. docGenFormFieldRequest (optional) options Options for modifying the behavior of the function.
- Returns
- DocGenFormFieldResponse
◆ UpdateEnvelopeDocGenFormFieldsAsync()
|
inline |
Updates formfields for an envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. docGenFormFieldRequest (optional) options Options for modifying the behavior of the function.
- Returns
- Task of DocGenFormFieldResponse
◆ UpdateEnvelopeDocGenFormFieldsAsyncWithHttpInfo()
|
inline |
Updates formfields for an envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. docGenFormFieldRequest (optional) options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (DocGenFormFieldResponse)
◆ UpdateEnvelopeDocGenFormFieldsWithHttpInfo()
|
inline |
Updates formfields for an envelope
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. docGenFormFieldRequest (optional) options Options for modifying the behavior of the function.
- Returns
- ApiResponse of DocGenFormFieldResponse
◆ UpdateEnvelopeScheduledSendingDefinition()
|
inline |
Updates the scheduled sending rules for an envelope's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. scheduledSending (optional)
- Returns
- ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeScheduledSendingDefinitionAsync()
|
inline |
Updates the scheduled sending rules for an envelope's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. scheduledSending (optional)
- Returns
- Task of ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeScheduledSendingDefinitionAsyncWithHttpInfo()
|
inline |
Updates the scheduled sending rules for an envelope's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. scheduledSending (optional)
- Returns
- Task of ApiResponse (ScheduledSending)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeScheduledSendingDefinitionWithHttpInfo()
|
inline |
Updates the scheduled sending rules for an envelope's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. scheduledSending (optional)
- Returns
- ApiResponse of ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeTransferRule()
|
inline |
Update an envelope transfer rule for an account. This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleId envelopeTransferRule (optional)
- Returns
- EnvelopeTransferRule
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeTransferRuleAsync()
|
inline |
Update an envelope transfer rule for an account. This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleId envelopeTransferRule (optional)
- Returns
- Task of EnvelopeTransferRule
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeTransferRuleAsyncWithHttpInfo()
|
inline |
Update an envelope transfer rule for an account. This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleId envelopeTransferRule (optional)
- Returns
- Task of ApiResponse (EnvelopeTransferRule)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeTransferRules()
|
inline |
Update envelope transfer rules for an account. This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleInformation (optional)
- Returns
- EnvelopeTransferRuleInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeTransferRulesAsync()
|
inline |
Update envelope transfer rules for an account. This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleInformation (optional)
- Returns
- Task of EnvelopeTransferRuleInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeTransferRulesAsyncWithHttpInfo()
|
inline |
Update envelope transfer rules for an account. This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleInformation (optional)
- Returns
- Task of ApiResponse (EnvelopeTransferRuleInformation)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeTransferRulesWithHttpInfo()
|
inline |
Update envelope transfer rules for an account. This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleInformation (optional)
- Returns
- ApiResponse of EnvelopeTransferRuleInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeTransferRuleWithHttpInfo()
|
inline |
Update an envelope transfer rule for an account. This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body. Note: You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeTransferRuleId envelopeTransferRule (optional)
- Returns
- ApiResponse of EnvelopeTransferRule
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeWorkflowDefinition()
|
inline |
Updates the envelope workflow definition for an envelope. Updates the specified envelope's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflow (optional)
- Returns
- Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeWorkflowDefinitionAsync()
|
inline |
Updates the envelope workflow definition for an envelope. Updates the specified envelope's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflow (optional)
- Returns
- Task of Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeWorkflowDefinitionAsyncWithHttpInfo()
|
inline |
Updates the envelope workflow definition for an envelope. Updates the specified envelope's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflow (optional)
- Returns
- Task of ApiResponse (Workflow)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeWorkflowDefinitionWithHttpInfo()
|
inline |
Updates the envelope workflow definition for an envelope. Updates the specified envelope's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflow (optional)
- Returns
- ApiResponse of Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeWorkflowStepDefinition()
|
inline |
Updates the envelope workflow step definition for an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId workflowStep (optional)
- Returns
- WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeWorkflowStepDefinitionAsync()
|
inline |
Updates the envelope workflow step definition for an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId workflowStep (optional)
- Returns
- Task of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeWorkflowStepDefinitionAsyncWithHttpInfo()
|
inline |
Updates the envelope workflow step definition for an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId workflowStep (optional)
- Returns
- Task of ApiResponse (WorkflowStep)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateEnvelopeWorkflowStepDefinitionWithHttpInfo()
|
inline |
Updates the envelope workflow step definition for an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. workflowStepId workflowStep (optional)
- Returns
- ApiResponse of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateLock()
|
inline |
Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. lockRequest (optional)
- Returns
- LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateLockAsync()
|
inline |
Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. lockRequest (optional)
- Returns
- Task of LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateLockAsyncWithHttpInfo()
|
inline |
Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. lockRequest (optional)
- Returns
- Task of ApiResponse (LockInformation)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateLockWithHttpInfo()
|
inline |
Updates an envelope lock. Updates the lock duration time or update the `lockedByApp` property information for the specified envelope. The user and integrator key must match the user specified by the `lockByUser` property and integrator key information and the `X-DocuSign-Edit` header must be included or an error will be generated.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. lockRequest (optional)
- Returns
- ApiResponse of LockInformation
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateNotificationSettings()
|
inline |
Sets envelope notification (Reminders/Expirations) structure for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeNotificationRequest (optional)
- Returns
- Notification
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateNotificationSettingsAsync()
|
inline |
Sets envelope notification (Reminders/Expirations) structure for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeNotificationRequest (optional)
- Returns
- Task of Notification
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateNotificationSettingsAsyncWithHttpInfo()
|
inline |
Sets envelope notification (Reminders/Expirations) structure for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeNotificationRequest (optional)
- Returns
- Task of ApiResponse (Notification)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateNotificationSettingsWithHttpInfo()
|
inline |
Sets envelope notification (Reminders/Expirations) structure for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelopeNotificationRequest (optional)
- Returns
- ApiResponse of Notification
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientDocumentVisibility()
|
inline |
Updates document visibility for the recipients This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. documentVisibilityList (optional)
- Returns
- DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientDocumentVisibilityAsync()
|
inline |
Updates document visibility for the recipients This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. documentVisibilityList (optional)
- Returns
- Task of DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientDocumentVisibilityAsyncWithHttpInfo()
|
inline |
Updates document visibility for the recipients This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. documentVisibilityList (optional)
- Returns
- Task of ApiResponse (DocumentVisibilityList)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientDocumentVisibilityWithHttpInfo()
|
inline |
Updates document visibility for the recipients This method updates document visibility for a recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. documentVisibilityList (optional)
- Returns
- ApiResponse of DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientInitialsImage()
|
inline |
Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientInitialsImageAsync()
|
inline |
Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientInitialsImageAsyncWithHttpInfo()
|
inline |
Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientInitialsImageWithHttpInfo()
|
inline |
Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipients()
|
inline |
Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional) options Options for modifying the behavior of the function.
- Returns
- RecipientsUpdateSummary
◆ UpdateRecipientsAsync()
|
inline |
Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional) options Options for modifying the behavior of the function.
- Returns
- Task of RecipientsUpdateSummary
◆ UpdateRecipientsAsyncWithHttpInfo()
|
inline |
Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional) options Options for modifying the behavior of the function.
- Returns
- Task of ApiResponse (RecipientsUpdateSummary)
◆ UpdateRecipientsDocumentVisibility()
|
inline |
Updates document visibility for the recipients This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentVisibilityList (optional)
- Returns
- DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientsDocumentVisibilityAsync()
|
inline |
Updates document visibility for the recipients This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentVisibilityList (optional)
- Returns
- Task of DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientsDocumentVisibilityAsyncWithHttpInfo()
|
inline |
Updates document visibility for the recipients This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentVisibilityList (optional)
- Returns
- Task of ApiResponse (DocumentVisibilityList)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientsDocumentVisibilityWithHttpInfo()
|
inline |
Updates document visibility for the recipients This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. documentVisibilityList (optional)
- Returns
- ApiResponse of DocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientSignatureImage()
|
inline |
Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientSignatureImageAsync()
|
inline |
Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientSignatureImageAsyncWithHttpInfo()
|
inline |
Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientSignatureImageWithHttpInfo()
|
inline |
Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to true and the `ExpressSendOnly` property in `SendingUser` structure must be set to false.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed.
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateRecipientsWithHttpInfo()
|
inline |
Updates recipients in a draft envelope or corrects recipient information for an in process envelope. Updates recipients in a draft envelope or corrects recipient information for an in process envelope. For draft envelopes, you can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`. Once an envelope has been sent, you can only edit: `email`, `userName`, `signerName`, `routingOrder`, `faxNumber`, and `deliveryMethod`. You can also select to resend an envelope by using the `resend_envelope` option. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the POST).
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipients (optional) options Options for modifying the behavior of the function.
- Returns
- ApiResponse of RecipientsUpdateSummary
◆ UpdateTabs()
|
inline |
Updates the tabs for a recipient. Updates one or more tabs for a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTabsAsync()
|
inline |
Updates the tabs for a recipient. Updates one or more tabs for a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- Task of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTabsAsyncWithHttpInfo()
|
inline |
Updates the tabs for a recipient. Updates one or more tabs for a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- Task of ApiResponse (Tabs)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTabsBlob()
|
inline |
Update encrypted tabs for envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTabsBlobAsync()
|
inline |
Update encrypted tabs for envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of void
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTabsBlobAsyncWithHttpInfo()
|
inline |
Update encrypted tabs for envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- Task of ApiResponse
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTabsBlobWithHttpInfo()
|
inline |
Update encrypted tabs for envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed.
- Returns
- ApiResponse of Object(void)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTabsWithHttpInfo()
|
inline |
Updates the tabs for a recipient. Updates one or more tabs for a recipient in a draft envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. recipientId The ID of the recipient being accessed. tabs (optional)
- Returns
- ApiResponse of Tabs
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateDelayedRoutingDefinition()
|
inline |
Updates the delayed routing rules for a template's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId delayedRouting (optional)
- Returns
- DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateDelayedRoutingDefinitionAsync()
|
inline |
Updates the delayed routing rules for a template's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId delayedRouting (optional)
- Returns
- Task of DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateDelayedRoutingDefinitionAsyncWithHttpInfo()
|
inline |
Updates the delayed routing rules for a template's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId delayedRouting (optional)
- Returns
- Task of ApiResponse (DelayedRouting)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateDelayedRoutingDefinitionWithHttpInfo()
|
inline |
Updates the delayed routing rules for a template's workflow step definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId delayedRouting (optional)
- Returns
- ApiResponse of DelayedRouting
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateRecipientDocumentVisibility()
|
inline |
Updates document visibility for the recipients This method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. recipientId The ID of the recipient being accessed. templateDocumentVisibilityList (optional)
- Returns
- TemplateDocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateRecipientDocumentVisibilityAsync()
|
inline |
Updates document visibility for the recipients This method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. recipientId The ID of the recipient being accessed. templateDocumentVisibilityList (optional)
- Returns
- Task of TemplateDocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateRecipientDocumentVisibilityAsyncWithHttpInfo()
|
inline |
Updates document visibility for the recipients This method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. recipientId The ID of the recipient being accessed. templateDocumentVisibilityList (optional)
- Returns
- Task of ApiResponse (TemplateDocumentVisibilityList)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateRecipientDocumentVisibilityWithHttpInfo()
|
inline |
Updates document visibility for the recipients This method updates the document visibility for a template recipient. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. recipientId The ID of the recipient being accessed. templateDocumentVisibilityList (optional)
- Returns
- ApiResponse of TemplateDocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateRecipientsDocumentVisibility()
|
inline |
Updates document visibility for the recipients This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. templateDocumentVisibilityList (optional)
- Returns
- TemplateDocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateRecipientsDocumentVisibilityAsync()
|
inline |
Updates document visibility for the recipients This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. templateDocumentVisibilityList (optional)
- Returns
- Task of TemplateDocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateRecipientsDocumentVisibilityAsyncWithHttpInfo()
|
inline |
Updates document visibility for the recipients This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. templateDocumentVisibilityList (optional)
- Returns
- Task of ApiResponse (TemplateDocumentVisibilityList)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateRecipientsDocumentVisibilityWithHttpInfo()
|
inline |
Updates document visibility for the recipients This method updates document visibility for one or more template recipients based on the `recipientId` and `visible` values that you include in the request body. Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. templateDocumentVisibilityList (optional)
- Returns
- ApiResponse of TemplateDocumentVisibilityList
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateScheduledSendingDefinition()
|
inline |
Updates the scheduled sending rules for a template's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. scheduledSending (optional)
- Returns
- ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateScheduledSendingDefinitionAsync()
|
inline |
Updates the scheduled sending rules for a template's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. scheduledSending (optional)
- Returns
- Task of ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateScheduledSendingDefinitionAsyncWithHttpInfo()
|
inline |
Updates the scheduled sending rules for a template's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. scheduledSending (optional)
- Returns
- Task of ApiResponse (ScheduledSending)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateScheduledSendingDefinitionWithHttpInfo()
|
inline |
Updates the scheduled sending rules for a template's workflow definition.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. scheduledSending (optional)
- Returns
- ApiResponse of ScheduledSending
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateWorkflowDefinition()
|
inline |
Updates the workflow definition for a template. Updates the specified template's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflow (optional)
- Returns
- Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateWorkflowDefinitionAsync()
|
inline |
Updates the workflow definition for a template. Updates the specified template's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflow (optional)
- Returns
- Task of Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateWorkflowDefinitionAsyncWithHttpInfo()
|
inline |
Updates the workflow definition for a template. Updates the specified template's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflow (optional)
- Returns
- Task of ApiResponse (Workflow)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateWorkflowDefinitionWithHttpInfo()
|
inline |
Updates the workflow definition for a template. Updates the specified template's workflow definition if it has one.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflow (optional)
- Returns
- ApiResponse of Workflow
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateWorkflowStepDefinition()
|
inline |
Updates the template workflow step definition for an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId workflowStep (optional)
- Returns
- WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateWorkflowStepDefinitionAsync()
|
inline |
Updates the template workflow step definition for an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId workflowStep (optional)
- Returns
- Task of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateWorkflowStepDefinitionAsyncWithHttpInfo()
|
inline |
Updates the template workflow step definition for an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId workflowStep (optional)
- Returns
- Task of ApiResponse (WorkflowStep)
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateTemplateWorkflowStepDefinitionWithHttpInfo()
|
inline |
Updates the template workflow step definition for an envelope.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. templateId The ID of the template being accessed. workflowStepId workflowStep (optional)
- Returns
- ApiResponse of WorkflowStep
Implements DocuSign.eSign.Api.IEnvelopesApi.
◆ UpdateWithHttpInfo()
|
inline |
Send Draft Envelope/Void Envelope/Move/Purge Envelope/Modify draft The Put Envelopes endpoint provides the following functionality: * Sends the specified single draft envelope. Add {"status":"sent"} to the request body to send the envelope. * Voids the specified in-process envelope. Add {"status":"voided", "voidedReason":"The reason for voiding the envelope"} to the request body to void the envelope. * Replaces the current email subject and message for a draft envelope. Add {"emailSubject":"subject", "emailBlurb":"message"} to the request body to modify the subject and message. * Place the envelope documents and envelope metadata in a purge queue so that this information is removed from the DocuSign system. Add {"purgeState":"purge type"} to the request body. Additional information on purging documents The purge request can only be used for completed envelopes that are not marked as the authoritative copy. The requesting user must have permission to purge documents and must be the sender (the requesting user can act as the sender using Send On Behalf Of). ###### Note: If you have set the Document Retention policy on your account, envelope documents are automatically placed in the purge queue and the warning emails are sent at the end of the retention period. ###### Note: You can set the Document Retention policy in the Classic DocuSign Experience by specifying the number of days to retain documents. ###### Note: Setting a Document Retention policy is the same as setting a schedule for purging documents. When the purge request is initiated the envelope documents, or documents and envelope metadata, are placed in a purge queue for deletion in 14 days. A warning email notification is sent to the sender and recipients associated with the envelope, notifying them that the envelope documents will be deleted in 14 days and providing a link to the documents. A second email is sent 7 days later with the same message. At the end of the 14-day period, the envelope documents are deleted from the system. If `purgeState="documents_queued"` is used in the request, then only the documents are deleted and any corresponding attachments and tabs remain in the DocuSign system. If `purgeState= "documents_and_metadata_queued"` is used in the request, then the documents, attachments, and tabs are deleted.
- Exceptions
-
DocuSign.eSign.Client.ApiException Thrown when fails to make API call
- Parameters
-
accountId The external account number (int) or account ID Guid. envelopeId The envelopeId Guid of the envelope being accessed. envelope (optional) options Options for modifying the behavior of the function.
- Returns
- ApiResponse of EnvelopeUpdateSummary
Property Documentation
◆ ApiClient
|
getset |
Gets or sets the ApiClient object
An instance of the ApiClient
◆ ExceptionFactory
|
getset |
Provides a factory method hook for the creation of exceptions.
The documentation for this class was generated from the following file:
- sdk/src/DocuSign.eSign/Api/EnvelopesApi.cs
