DocuSign Connector 1.1 Reference | MuleSoft Documentation
# DocuSign Connector 1.1 Reference
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.  
---  
Anypoint Connector for DocuSign (DocuSign Connector) enables you to access the DocuSign platform and exposes operations provided by the DocuSign eSignature API v2.1. Visit the DocuSign API reference site to learn more.
The connector does not perform validation on certain fields, such as **Envelope Id** or **Document Id** , so you must validate input values for these fields before sending them to the API and invoking the connector’s operations and sources. For example, you can use the **Matches regex** operation from Validation Module to validate input values for these fields. If you do not validate input values for these fields, there is a possibility of a path traversal attack.   
---  
## Configurations
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection | 
  * Authorization Connection Provider
  * JWT Connection Provider (JWT Grant)
  * Oauth Connection Provider

| The connection types to provide to this configuration.  
Response Timeout | Timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content.  
The identifier of this element used to reference it in other components  
Expiration Policy |  Expiration Policy | Minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.  
## Connection Types
### Authorization Connection Provider (Implicit Grant)
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | Timeout for establishing connections to the remote service  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Connection Timeout field.  
Use Persistent Connections | If false, each connection is closed after the first request is completed.  
Max Connections | Maximum number of outbound connections to keep open concurrently.  
Connection Idle Timeout | Timeout for how long a connection can remain idle before it is closed.  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Connection Idle Timeout field.  
Proxy Config | Reusable configuration element for outbound connections through a proxy.  
Stream Response | Whether or not to stream received responses.  
Response Buffer Size | The space in bytes for the buffer where the HTTP response will be stored.  
Base Uri | Parameter base URI for each instance or tenant. In the DocuSign app, go to **Settings > Apps and Keys > My Account Information** to find the account base URI and then add `/restapi` to the end, for example, `https://demo.docusign.net/restapi`. | `https://www.docusign.net/restapi`  
Authorization | Access token obtained by the user from the `https://account-d.docusign.com/oauth/token` endpoint in the `Bearer {access_token}` format, for example, `Bearer aeK9rESiOeNHYB`. For more information about generating an access token, refer to How to Get an Access Token with Authorization Code Grant.  
TLS Configuration  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
### JWT Connection Provider (JWT Grant)
Use JWT Grant for server-to-server or machine-to-machine communication for authentication without user involvement. The client authenticates using a signed JWT, which the authorization server or resource server verifies.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header | Default headers.  
Query Parameters |  Array of Default Query Param | Query parameters.  
Connection Timeout | Timeout for establishing connections to the remote service.  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Connection Timeout** field.  
Use Persistent Connections | If false, each connection is closed after the first request is completed.  
Max Connections | Maximum number of outbound connections to keep open concurrently.  
Connection Idle Timeout | Timeout for how long a connection can remain idle before it is closed.  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the **Connection Idle Timeout** field.  
Proxy Config | Reusable configuration element for outbound connections through a proxy.  
Stream Response | Whether or not to stream received responses.  
Response Buffer Size | The space in bytes for the buffer where the HTTP response is stored.  
Base Uri | Parameter base URI for each instance or tenant. In the DocuSign app, go to **Settings > Apps and Keys > My Account Information** to find the account base URI and then add `/restapi` to the end, for example, `https://demo.docusign.net/restapi`. | `https://www.docusign.net/restapi`  
Integration Key | Integration key that identifies the integration and links to its configuration values with the service provider.  
Impersonated user id | The user ID is a unique identifier associated with the user in the DocuSign system.  
Requested Scopes | A space-delimited list of the scopes the app needs. For JWT Grant, this must include the `impersonation` scope.  
Private Key | The RSA private key.  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
### OAuth Connection Provider (Authorization Code Grant)
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Default Headers |  Array of Default Header  
Query Parameters |  Array of Default Query Param  
Connection Timeout | Timeout for establishing connections to the remote service.  
Connection Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Connection Timeout field.  
Use Persistent Connections | If false, each connection is closed after the first request is completed.  
Max Connections | Mzximum number of outbound connections to keep open concurrently.  
Connection Idle Timeout | Timeout for how long a connection can remain idle before it is closed.  
Connection Idle Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Time unit for the Connection Idle Timeout field.  
Proxy Config | Reusable configuration element for outbound connections through a proxy.  
Stream Response | Whether or not received responses should be streamed  
Response Buffer Size | The space in bytes for the buffer where the HTTP response will be stored.  
Base Uri | Parameter base URI for each instance or tenant. | `https://www.docusign.net/restapi`  
TLS Configuration  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
Consumer Key | OAuth consumer key as registered with the service provider.  
Consumer Secret | OAuth consumer secret as registered with the service provider.  
Authorization Url | Service provider’s authorization endpoint URL. | `https://account-d.docusign.com/oauth/auth`  
Access Token Url | Service provider’s access token endpoint URL. | `https://account-d.docusign.com/oauth/token`  
OAuth scopes to be requested during the OAuth dance. If not provided, it defaults to the scopes in the annotation. | signature  
Resource Owner Id | The resource owner ID that each component should use if it is not otherwise referenced.  
Name of the flow to execute immediately before starting the OAuth dance.  
Name of a flow to execute immediately after an access token is received.  
Listener Config | References the HTTP configuration used to create the listener that receives the access token callback endpoint.  
Callback Path | Path of the access token callback endpoint.  
Authorize Path | Path of the local HTTP endpoint that triggers the OAuth dance.  
External Callback Url | URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.  
Object Store | Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.  
## List of Operations
  * Accounts Post Accounts
  * Billing Payments Post Payment
  * Brands Post Brands
  * Bulk Send V2CRUD Post Bulk Send List
  * Bulk Send V2Send Post Bulk Send Request
  * Bulk Send V2Test Post Bulk Send Test Request
  * Chunked Uploads Post Chunked Uploads
  * Connect Post Connect Configuration
  * Contacts Post Contacts
  * Account Custom Fields Post Account Custom Fields
  * Envelopes Post Envelopes
  * Custom Fields Post Custom Fields
  * Document Fields Post Document Fields
  * Responsive Html Post Document Responsive Html Preview
  * Tabs Post Document Tabs
  * Templates Post Document Templates
  * Email Settings Post Email Settings
  * Lock Post Envelope Lock
  * Recipients Post Recipients
  * Recipients Post Recipient Proof File Resource Token
  * Recipients Post Recipient Tabs
  * Responsive Html Post Responsive Html Preview
  * Templates Post Envelope Templates
  * Envelope Transfer Rules Post Envelope Transfer Rules
  * Views Post Envelope Correct View
  * Views Post Envelope Edit View
  * Views Post Envelope Recipient View
  * Views Post Envelope Recipient Preview
  * Views Post Envelope Sender View
  * Views Post Envelope Recipient Shared View
  * Groups Post Groups
  * Permission Profiles Post Permission Profiles
  * Power Forms Post Power Form
  * Reports In Product Post Report In Product Create
  * BCCEmail Archive Post BCCEmail Archive
  * Account Signatures Post Account Signatures
  * Signing Groups Post Signing Groups
  * Tabs Post Tab Definitions
  * Templates Post Templates
  * Custom Fields Post Template Custom Fields
  * Document Fields Post Template Document Fields
  * Responsive Html Post Template Document Responsive Html Preview
  * Tabs Post Template Document Tabs
  * Lock Post Template Lock
  * Recipients Post Template Recipients
  * Recipients Post Template Recipient Tabs
  * Responsive Html Post Template Responsive Html Preview
  * Views Post Template Edit View
  * Views Post Template Recipient Preview
  *   * Cloud Storage Post Cloud Storage
  * User Signatures Post User Signatures
  * Views Post Account Console View
  * Workspace Post Workspace
  * Workspace File Post Workspace Files
  * Notary Post Notary
  * Notary Jurisdictions Post Notary Jurisdictions
  * Brands Delete Brands
  *   * Brand Logo Delete Brand Logo
  * Bulk Send V2CRUD Delete Bulk Send List
  * Accounts Delete Account
  * Captive Recipients Delete Captive Recipients Part
  * Chunked Uploads Delete Chunked Upload
  * Connect Delete Connect Config
  * Connect Failures Delete Connect Failure Log
  * Connect Log Delete Connect Logs
  * Connect Log Delete Connect Log
  * Contacts Delete Contacts
  * Contacts Delete Contact With Id
  * Account Custom Fields Delete Account Custom Fields
  * Attachments Delete Attachments
  * Custom Fields Delete Custom Fields
  * Documents Delete Documents
  * Document Fields Delete Document Fields
  *   * Tabs Delete Document Tabs
  * Templates Delete Document Templates
  * Email Settings Delete Email Settings
  * Lock Delete Envelope Lock
  * Recipients Delete Recipients
  * Recipients Delete Recipient
  * Recipients Delete Recipient Tabs
  * Envelope Transfer Rules Delete Envelope Transfer Rules
  * Views Delete Envelope Correct View
  * Envelope Workflow Definition Delete Envelope Workflow Definition
  * Favorite Templates Un Favorite Template
  * Brands Delete Group Brands
  * Groups Delete Groups
  * Groups Delete Group Users
  * Permission Profiles Delete Permission Profiles
  * Power Forms Delete Power Forms List
  * Power Forms Delete Power Form
  * Reports In Product Delete Report In Product
  * BCCEmail Archive Delete BCCEmail Archive
  * ENote Configuration Delete ENote Configuration
  * Account Signatures Delete Account Signature
  * Account Signatures Delete Account Signature Image
  * Signing Groups Delete Signing Groups
  * Signing Groups Delete Signing Group Users
  * Tab Delete Custom Tab
  * Templates Delete Template Part
  * Custom Fields Delete Template Custom Fields
  * Documents Delete Template Documents
  * Document Fields Delete Template Document Fields
  * Pages Delete Template Page
  * Tabs Delete Template Document Tabs
  * Lock Delete Template Lock
  * Recipients Delete Template Bulk Recipients File
  * Recipients Delete Template Recipients
  * Recipients Delete Template Recipient
  * Recipients Delete Template Recipient Tabs
  * Envelope Workflow Definition Delete Template Workflow Definition
  * Users Delete Users
  * Cloud Storage Delete Cloud Storage Providers
  * Cloud Storage Delete Cloud Storage
  * User Custom Settings Delete Custom Settings
  * User Profile Image Delete User Profile Image
  * User Signatures Delete User Signature
  * User Signatures Delete User Signature Image
  * Workspace Delete Workspace
  * Workspace Folder Delete Workspace Items
  * Notary Jurisdictions Delete Notary Jurisdiction
  * APIRequest Log Delete Request Logs
  * Service Information Get Service Information
  * Service Information Get Resource Information
  * Billing Charges Get Account Billing Charges
  * Billing Invoices Get Billing Invoices
  * Billing Invoices Get Billing Invoice
  * Billing Invoices Get Billing Invoices Past Due
  * Billing Payments Get Payment List
  * Billing Payments Get Payment
  * Billing Plan Get Billing Plan
  * Billing Plan Get Credit Card Info
  * Billing Plan Get Downgrade Request Billing Info
  *   *   * Brand Export Get Brand Export File
  * Brand Logo Get Brand Logo
  * Brand Resources Get Brand Resources List
  * Brand Resources Get Brand Resources
  * Bulk Send V2Batch Get Bulk Send Batches
  * Bulk Send V2Batch Get Bulk Send Batch Status
  * Bulk Send V2CRUD Get Bulk Send Lists
  * Bulk Send V2CRUD Get Bulk Send List
  * Accounts Get Account
  * Chunked Uploads Get Chunked Upload
  * Connect Get Connect Configs
  * Connect Get Connect Config
  * Connect Failures Get Connect Logs
  * Connect Log Get Connect Logs
  * Connect Log Get Connect Log
  * Connect Get Connect Users
  * Consumer Disclosure Get Consumer Disclosure
  * Consumer Disclosure Get Consumer Disclosure Lang Code
  * Contacts Get Contact By Id
  * Account Custom Fields Get Account Custom Fields
  * Attachments Get Attachments
  * Attachments Get Attachment
  * Audit Events Get Audit Events
  * Envelopes Get Envelopes
  * Envelopes Get Envelope
  * Comments Get Comments Transcript
  * Custom Fields Get Custom Fields
  * Documents Get Documents
  * Documents Get Document
  * Document Fields Get Document Fields
  * Responsive Html Get Envelope Document Html Definitions
  *   *   *   *   * Templates Get Document Templates
  * Email Settings Get Email Settings
  * Form Data Get Form Data
  * Responsive Html Get Envelope Html Definitions
  * Lock Get Envelope Lock
  * Notification Get Envelopes Envelope Id Notification
  * Recipients Get Recipients
  * Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id
  * Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id Lang Code
  * Recipients Get Recipient Document Visibility
  * Recipients Get Recipient Initials Image
  * Recipients Get Recipient Signature
  * Recipients Get Recipient Signature Image
  * Recipients Get Recipient Tabs
  * Tabs Blob Get Tabs Blob
  * Templates Get Envelope Templates
  * Envelope Transfer Rules Get Envelope Transfer Rules
* Connect Get Connect Users
  * Consumer Disclosure Get Consumer Disclosure
  * Consumer Disclosure Get Consumer Disclosure Lang Code
  * Contacts Get Contact By Id
  * Account Custom Fields Get Account Custom Fields
  * Attachments Get Attachments
  * Attachments Get Attachment
  * Audit Events Get Audit Events
  * Envelopes Get Envelopes
  * Envelopes Get Envelope
  * Comments Get Comments Transcript
  * Custom Fields Get Custom Fields
  * Documents Get Documents
  * Documents Get Document
  * Document Fields Get Document Fields
  * Responsive Html Get Envelope Document Html Definitions
  *   *   *   *   * Templates Get Document Templates
  * Email Settings Get Email Settings
  * Form Data Get Form Data
  * Responsive Html Get Envelope Html Definitions
  * Lock Get Envelope Lock
  * Notification Get Envelopes Envelope Id Notification
  * Recipients Get Recipients
  * Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id
  * Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id Lang Code
  * Recipients Get Recipient Document Visibility
  * Recipients Get Recipient Initials Image
  * Recipients Get Recipient Signature
  * Recipients Get Recipient Signature Image
  * Recipients Get Recipient Tabs
  * Tabs Blob Get Tabs Blob
  * Templates Get Envelope Templates
  * Envelope Transfer Rules Get Envelope Transfer Rules
  * Envelope Workflow Definition Get Envelope Workflow Definition
  * Favorite Templates Get Favorite Templates
  * Folders Get Folders
  * Folders Get Folder Items
  * Brands Get Group Brands
  *   * Groups Get Group Users
  * Account Identity Verification Get Account Identity Verification
  * Payment Gateway Accounts Get All Payment Gateway Accounts
  * Permission Profiles Get Permission Profiles
  * Permission Profiles Get Permission Profile
  * Power Forms Get Power Forms List
  * Power Forms Get Power Form
  * Power Forms Get Power Form Data
  * Power Forms Get Power Forms Senders
  * Accounts Get Provisioning
  * Recipient Names Get Recipient Names
  * Reports In Product Get Report In Product List
  * Reports In Product Get Report In Product
  * Account Signature Providers Get Seal Providers
  * Search Folders Get Search Folder Contents
  * BCCEmail Archive Get BCCEmail Archive List
  * BCCEmail Archive Get BCCEmail Archive History List
  * Settings Get Settings
  * ENote Configuration Get ENote Configuration
  * Envelope Purge Configuration Get Envelope Purge Configuration
  * Notification Defaults Get Notification Defaults
  * Account Password Rules Get Account Password Rules
  * Tab Settings Get Tab Settings
  * Shared Access Get Shared Access
  * Account Signature Providers Get Signature Providers
  * Account Signatures Get Account Signatures
  * Account Signatures Get Account Signature
  * Account Signatures Get Account Signature Image
  * Signing Groups Get Signing Groups
  * Signing Groups Get Signing Group
  * Signing Groups Get Signing Group Users
  * Supported Languages Get Supported Languages
  * Tabs Get Tab Definitions
  *   * Templates Get Templates
  * Templates Get Template
  * Custom Fields Get Template Custom Fields
  * Documents Get Template Documents
  * Documents Get Template Document
  * Document Fields Get Template Document Fields
  * Responsive Html Get Template Document Html Definitions
  * Pages Get Template Page Images
  * Pages Get Template Page Image
  * Tabs Get Template Page Tabs
  * Tabs Get Template Document Tabs
  * Responsive Html Get Template Html Definitions
  * Lock Get Template Lock
  * Notification Get Templates Template Id Notification
  * Recipients Get Template Bulk Recipients
  * Recipients Get Template Recipients
  * Recipients Get Template Recipient Document Visibility
  * Recipients Get Template Recipient Tabs
  * Envelope Workflow Definition Get Template Workflow Definition
  * Unsupported File Types Get Unsupported File Types
  *   *   * Cloud Storage Get Cloud Storage Providers
  * Cloud Storage Get Cloud Storage
  * Cloud Storage Folder Get Cloud Storage Folder All
  * Cloud Storage Folder Get Cloud Storage Folder
  * User Custom Settings Get Custom Settings
  * User Profile Get Profile
  * User Profile Image Get User Profile Image
  * User Settings Get User Settings
  * User Signatures Get User Signatures
  * User Signatures Get User Signature
  * User Signatures Get User Signature Image
  * Watermark Get Watermark
  * Workspace Get Workspaces
  * Workspace Get Workspace
  * Workspace Folder Get Workspace Folder
  * Workspace File Get Workspace File
  * Workspace File Pages Get Workspace File Pages
  * Billing Plans Get Billing Plans
  * Billing Plans Get Billing Plan
  * Notary Get Notary
  * Notary Journals Get Notary Journals
  * Notary Jurisdictions Get Notary Jurisdictions
  * Notary Jurisdictions Get Notary Jurisdiction
  * Password Rules Get Password Rules
  * APIRequest Log Get Request Logs
  * APIRequest Log Get Request Log
  * APIRequest Log Get Request Log Settings
  *   * Billing Plan Put Billing Plan
  * Billing Plan Put Downgrade Account Billing Plan
  * Purchased Envelopes Put Purchased Envelopes
  *   * Brand Logo Put Brand Logo
  * Brand Resources Put Brand Resources
  * Bulk Send V2CRUD Put Bulk Send List
  * Chunked Uploads Put Chunked Uploads
  * Chunked Uploads Put Chunked Upload Part
  * Connect Put Connect Configuration
  * Connect Publish Put Connect Retry
  * Connect Publish Put Connect Retry By Envelope
  * Consumer Disclosure Put Consumer Disclosure
  * Contacts Put Contacts
  * Account Custom Fields Put Account Custom Fields
  * Attachments Put Attachments
  * Attachments Put Attachment
  * Envelopes Put Envelope
  * Custom Fields Put Custom Fields
  * Documents Put Documents
  *   * Document Fields Put Document Fields
  *   *   * Email Settings Put Email Settings
  * Lock Put Envelope Lock
  * Notification Put Envelopes Envelope Id Notification
  * Recipients Put Recipients
  * Recipients Put Recipients Document Visibility
  * Recipients Put Recipient Document Visibility
  * Recipients Put Recipient Initials Image
  * Recipients Put Recipient Signature Image
  * Recipients Put Recipient Tabs
  * Envelopes Put Status
  * Tabs Blob Put Tabs Blob
  * Envelope Transfer Rules Put Envelope Transfer Rules
  * Envelope Transfer Rules Put Envelope Transfer Rule
  * Envelope Workflow Definition Put Envelope Workflow Definition
  * Favorite Templates Put Favorite Template
  * Folders Put Folder By Id
  * Brands Put Group Brands
  *   * Groups Put Group Users
  * Permission Profiles Put Permission Profiles
  * Power Forms Put Power Form
  * Reports In Product Put Report In Product Save
  * Reports In Product Put Report In Product Run Results
  * Reports In Product Put Report Results Csv
  * Settings Put Settings
  * ENote Configuration Put ENote Configuration
  * Envelope Purge Configuration Put Envelope Purge Configuration
  * Notification Defaults Put Notification Defaults
  * Account Password Rules Put Account Password Rules
  * Tab Settings Put Settings
  * Shared Access Put Shared Access
  * Account Signatures Put Account Signature
  * Account Signatures Put Account Signature By Id
  * Account Signatures Put Account Signature Image
  * Signing Groups Put Signing Groups
  * Signing Groups Put Signing Group
  * Signing Groups Put Signing Group Users
  *   * Templates Put Template
  * Templates Put Template Part
  * Custom Fields Put Template Custom Fields
  * Documents Put Template Documents
  * Documents Put Template Document
  * Document Fields Put Template Document Fields
  * Pages Put Template Page Image
  * Tabs Put Template Document Tabs
  * Lock Put Template Lock
  * Notification Put Templates Template Id Notification
  * Recipients Put Template Bulk Recipients
  * Recipients Put Template Recipients
  * Recipients Put Template Recipients Document Visibility
  * Recipients Put Template Recipient Document Visibility
  * Recipients Put Template Recipient Tabs
  * Envelope Workflow Definition Put Template Workflow Definition
  *   *   * User Custom Settings Put Custom Settings
  * User Profile Put Profile
  * User Profile Image Put User Profile Image
  * User Settings Put User Settings
  * User Signatures Put User Signature
  * User Signatures Put User Signature By Id
  * User Signatures Put User Signature Image
  * Watermark Put Watermark
  * Watermark Preview Put Watermark Preview
  * Workspace Put Workspace
  * Workspace File Put Workspace File
  * Notary Put Notary
  * Notary Jurisdictions Put Notary Jurisdiction
  * APIRequest Log Put Request Log Settings
## Sources
  * On Envelope Status Change Trigger


## On Envelope Status Change Trigger
`<docusign:on-envelope-status-change-trigger>`
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID  
From Date | The date/time setting that specifies when the request begins checking for status changes for envelopes in the account.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Primary Node Only | Whether this source should only be executed on the primary node when running in a cluster  
Scheduling Strategy |  scheduling-strategy | Configures the scheduler that triggers the polling  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

## Accounts Post Accounts
`<docusign:create-v21-accounts>`
Creates new DocuSign accounts. You can use this method to create a single account or up to 100 accounts at a time.
**Note** : This method is restricted to partner integrations. You must work with DocuSign Professional Services or DocuSign Business Development, who will provide you with the Distributor Code and Distributor Password that you need to include in the request body. You must include the `X-DocuSign-Authentication` header, for example `{{integratorKey}}`.
When creating a single account, the body of the request is a `[newAccountRequest]` object, for example:
```
{
 "newAccountRequest": [
  {
   "accountName": "Test Account",
   "distributorCode": "MY_DIST_CODE",
   "distributorPassword": "MY_DIST_PWD",
   "initialUser": {
    "email": "user@emaildomain.com",
    "firstName": "John",
    "middleName": "Harry",
    "lastName": "Doe",
    "suffixName": "",
    "userName": "John Doe",
    "jobTitle": "Engineer",
    "company": "Test Company"
   },
   "addressInformation": {
    "address1": "1234 Main Street",
    "address2": "Suite 100",
    "city": "Seattle",
    "state": "WA",
    "postalCode": "98101",
    "country": "US",
    "phone": "1234567890",
    "fax": "1234567891"
   },
   "planInformation": {
    "planId": "37085696-xxxx-xxxx-xxxx-7ea067752959"
   },
   "referralInformation": {
    "includedSeats": "1",
    "referralCode": "code",
    "referrerName": "name"
   }
  }
 ]
}
```

If the request succeeds, it returns a 201 (Created) HTTP response code. The response returns the new account ID, password, and the default user information for each newly created account.
When creating multiple accounts, the body of the request is a `newAccountRequests` object, which contains one or more `[newAccountDefinition]` objects. You can create up to 100 new accounts at a time this way. The body for a multi-account creation request looks like this in JSON:
```
{
  "newAccountRequests": [
   { "accountName": "accountone", . . . },
   { "accountName": "accounttwo", . . . }
 ]
}
```

A multi-account creation request might succeed (report a 201 code) even if some accounts could not be created. In this case, the `errorDetails` property in the response contains specific information about the failure.
This operation makes an HTTP POST request to the /v2.1/accounts endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

|  Specifies how the connector streams request content to the remote service:
  * `AUTO` (default) Connector automatically uses the best streaming strategy based on the request content.
  * `ALWAYS` Connector always streams the request content.
  * `NEVER` Connector does not stream the request content.

  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Billing Payments Post Payment
`<docusign:create-v21-accounts-billing-payments-by-account-id>`
Posts a payment to a past due invoice. This method can only be used if the `paymentAllowed` value for a past due invoice is true. This can be determined calling Billing::listInvoicesPastDue. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the `nextUri` and `previousUri` properties are not returned.
Privileges required: account administrator
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/billing_payments endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Brands Post Brands
`<docusign:create-v21-accounts-brands-by-account-id>`
This method creates one or more brand profile files for an account. If the `brandId` property for a brand profile is already set for the account, an error is returned. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When you upload brand profile files, you must combine them into a single zip file and set the `Content-Type` to `application/zip`.
**Note** : Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/brands endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Bulk Send V2CRUD Post Bulk Send List
`<docusign:create-v21-accounts-bulk-send-lists-by-account-id>`
Creates a bulk send list that you can use to send an envelope to up to 1,000 recipients concurrently. It returns the following errors:
Error code | Description  
---|---  
BULK_SEND_MAX_COPIES_EXCEEDED | A bulk sending list cannot specify more than XXX copies in the mailing list. Call the settings API endpoint to find the maximum number of copies in a batch allowed for your account. In almost all cases, the default limit is 1000.  
BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE | No two recipientIds can be same within a bulkCopy. Same restriction as a regular envelope applies. Specify unique recipient IDs for each recipient within a bulkCopy (model for envelope in mailing list).  
BULK_SEND_RECIPIENT_ID_REQUIRED | If no RoleName is present, recipientID is required in mailing list’s bulkCopy. Add a roleName (that coalesces with template/envelope) or a recipientID.  
BULK_SEND_RECIPIENT_NAME_REQUIRED | Recipient {0} has no name. Specify a name for the recipient.  
BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT | Recipient {0} is an email recipient with no email address. Specify an email for the email recipient.  
BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT | Recipient {0} is a fax recipient with no fax number. Specify a fax number for the fax recipient.  
BULK_SEND_FAX_NUMBER_NOT_VALID | Recipient {0} specifies fax number {1}, which is not valid. Specify a valid fax number for the fax recipient.  
BULK_SEND_EMAIL_ADDRESS_NOT_VALID | Recipient {0} specifies email address {1}, which is not a valid email address. Specify a valid email address for the recipient.  
BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH | Recipient {0} specifies SMS auth, but no number was provided. Specify a phone number for the SMS auth recipient.  
BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH | Recipient {0} specifies phone number {1} for SMS auth, which is not valid. Specify a valid phone number for the SMS auth recipient.  
BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE | Recipient role names cannot be duplicated; role {duplicateRecipientRole} appears multiple times. Use unique roleNames for recipients.  
BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT | Recipients cannot have both ID and Role; {0} has both. Specify a roleName or recipientId, but not both for the same recipient.  
BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST | Cannot use both recipient role and ID in the same list. Specify a roleName or recipientId, but not both in the same list.  
BULK_SEND_INVALID_ID_CHECK_CONFIGURATION | Recipient {0} specified SMS authentication, but no SMS auth settings were provided. Provide an SMS auth setting (proper ID configuration) if SMS auth is specified.  
BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION | Recipient {0} has more than one signature provider specified. Or signingProviderName is not specified. Or Signature provider : {0} is either unknown or not an available pen for this account. One or more SBS configuration is missing or invalid. The error details provide specifics.  
BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE | Tab label {0} is duplicated. Needs to be unique. Use a unique tab label.  
BULK_SEND_TAB_LABEL_REQUIRED | Tab label is required. Specify a tab label.  
BULK_SEND_TAB_VALUE_REQUIRED | Tab Label value is required. Specify a value for the tab label.  
BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE | Custom fields must have distinct names. The field {0} appears more than once in a copy. Use unique names for custom fields.  
BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED | All custom fields must have names. Specify a name for the custom field.  
BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED | Custom field {0} has no value. A custom field can have an empty value, but it cannot have a null value. Specify a value for the custom field.  
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/bulk_send_lists endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The ID of the account.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Bulk Send V2Send Post Bulk Send Request
`<docusign:create-v21-accounts-bulk-send-lists-send-by-account-id-bulk-send-list-id>`
Initiates the bulk send process. It generates a bulk send request based on an existing bulk send list and an envelope or template. Consider using the createBulkSendTestRequest method to test your bulk send list for compatibility with the envelope or template that you want to send first. If the envelopes were successfully queued for asynchronous processing, the response contains a `batchId` that you can use to get the status of the batch. If a failure occurs, the API returns an error message.
**Note** : Partial success or failure generally does not occur. Only the entire batch is queued for asynchronous processing.
This method returns the following errors:
Error code | Description  
---|---  
BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE | Envelope {0} is not in a sendable state. The envelope is not complete. Make sure it has a sendable status, such as `created`.  
BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES | Cannot send an envelope with a bulk sending list which contains no copies. The list you’re trying to bulk send is empty. Make sure the bulk sending list you’re using contains recipients.  
BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES | Bulk sending list contains more than {0} copies. The list you’re trying to bulk send will cause your account to exceed the 1,000-copy limit imposed for all accounts. Try sending two or more separate lists.  
BULK_SEND_ENVELOPE_CANNOT_BE_NULL | Cannot send a bulk list without an envelope. Specify the envelope ID or template ID for the envelope you want to bulk send.  
BULK_SEND_BLOB_STORE_ERROR | Could not save copy of bulk sending list. An error writing to the database occurred. Try again. If the error persists, contact DocuSign Support.  
BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES | Cannot send this bulk sending list because doing so would exceed the maximum of {maxCopies} in-flight envelopes. This account currently has {unprocessedEnvelopes} envelopes waiting to be processed. Please try again later." .Try again later, or contact DocuSign Support to request a higher tier.  
BULK_SEND_ENVELOPE_NOT_FOUND | Envelope {envelopeOrTemplateId} does not exist or you do not have permission to access it. The envelopeId or templateId specified could not be found. Specify a valid value.  
BULK_SEND_LIST_NOT_FOUND | Bulk Sending list {listId} does not exist or you do not have permission to access it. The mailingListId specified could not be found. Specify a valid value.  
BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS | Bulk sending copy contains recipients, but the specified envelope does not. The recipients on the envelope and the bulk send list do not match. Make sure the envelope and list are compatible for sending.  
BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE | Recipient {0} does not exist in the envelope. Add the missing recipient to the envelope.  
BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH | Recipient ID {envelopeMember.ID} does not match. Make sure the recipient information in the list and the envelope match up.  
BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT | Recipient {0} is a bulk recipient. This is not supported. No legacy 'bulk recipient' allowed. In v2.1 of the eSignature API, you must use a bulk send list instead of a bulk recipient. See the API documentation for details.  
BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH | Recipient Role {envelopeMember.RoleName} does not match. Make sure the recipient information in the list and the envelope is compatible.  
BULK_SEND_DUPLICATE_RECIPIENT_DETECTED | Duplicate recipients ({0}) not allowed, unless recipients have unique routing order specified on envelope.  
BULK_SEND_ENVELOPE_HAS_NO_TABS | Bulk sending copy contains tabs, but the specified envelope does not. List and envelope tabs cannot be coalesced. Make sure they are compatible for sending.  
BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE | Tab with label {0} does not exist in envelope. Add the tab label to the envelope, remove the label from the list, or make sure you’re specifying the correct list and envelope.  
BULK_SEND_TAB_DOES_NOT_MATCH | Tab {0} does not match {0} in envelope. A tab exists on the list that does not match or is missing on the envelope. Make sure the tabs on the list and the envelope match.  
BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS | Bulk sending copy contains custom fields, but the specified envelope does not. There are custom fields on the list that the envelope does not have. Make sure that any custom fields on the list and the envelope match.  
BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE | Custom field {0} does not exist in the envelope. Either add the custom field on the list to the envelope, remove the custom field from the list, or make sure you’re specifying the correct list and envelope.  
BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH | Custom field names must match. {0} and {1} do not match. The custom field names on the list and the envelope do not match. Use identical names for both.  
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Bulk Send List Id | The GUID of the bulk send list. This property is created after you post a new bulk send list.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  *
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Bulk Send V2Test Post Bulk Send Test Request
`<docusign:create-v21-accounts-bulk-send-lists-test-by-account-id-bulk-send-list-id>`
This method tests a bulk send list for compatibility with the envelope or template that you want to send. For example, a template that has three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to test compatibility first. A successful test result returns `true` for the `canBeSent` property. An unsuccessful test returns a JSON response that contains information about the errors that occurred. If the test is successful, you can then send the envelope or template by using the BulkSendRequest method.
### Envelope Compatibility Checks
This section describes the envelope compatibility checks that the system performs.
**Top-Level Issues**
  * Envelopes must be in a sendable state.
    * The bulk send list must contain at least one copy (instance of an envelope), and no more than the maximum number of copies allowed for the account.
    * The envelope must not be null and must be visible to the current user.
    * The account cannot have more queued envelopes than the maximum number configured for the account.
    * The bulk send list must exist.
  * **Recipients**
    * The envelope must have recipients.
    * If you are using an envelope, all of the recipients defined in the bulk send list must have corresponding recipient IDs in the envelope definition. If you are using a template, you must either match the recipient IDs or role IDs.
    * The envelope cannot contain a bulk recipient (an artifact of the legacy version of DocuSign’s bulk send functionality).
  * **Recipient Tabs**
    * Every `recipient ID, tab label` pair in the bulk send list must correspond to a tab in the envelope.
  * **Custom Fields**
    * Each envelope-level custom field in the bulk send list must correspond to the name of a `customField` in the envelope definition. You do not have to match the recipient-level custom fields.


This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Bulk Send List Id | The GUID of the bulk send list. This property is created after you post a new bulk send list.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Chunked Uploads Post Chunked Uploads
`<docusign:create-v21-accounts-chunked-uploads-by-account-id>`
This method initiates a new chunked upload with the first part of the content. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/chunked_uploads endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Connect Post Connect Configuration
`<docusign:create-v21-accounts-connect-by-account-id>`
Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. These updates might or might not include the document itself.
**Note** : Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/connect endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Contacts Post Contacts
`<docusign:create-v21-accounts-contacts-by-account-id>`
This method imports multiple new contacts into a contact list from a CSV, JSON, or XML file. To use this method, you must provide a request body in one of the supported formats and include a `content-type` header with the appropriate value. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/contacts endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Account Custom Fields Post Account Custom Fields
`<docusign:create-v21-accounts-custom-fields-by-account-id>`
This method creates a custom field and makes it available for all new envelopes associated with an account. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/custom_fields endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Apply to templates | (Optional) When set to **true** , the new custom field is applied to all of the templates on the account.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Envelopes Post Envelopes
`<docusign:create-v21-accounts-envelopes-by-account-id>`
Creates and sends an envelope or creates a draft envelope. Envelopes are fundamental resources in the DocuSign platform. With this method you can:
  * Create and send an envelope with documents, recipients, and tabs.
  * Create and send an envelope from a template.
  * Create and send an envelope from a combination of documents and templates.
  * Create a draft envelope.


When you use this method to create and send an envelope in a single request, the following parameters in the request body are required:
Parameter | Description  
---|---  
Set to `sent` to send the envelope to recipients. Set to `created` (or don’t set at all) to save the envelope as a draft.  
`emailSubject` | The subject of the email used to send the envelope.  
`documents` | The [documents][] to be signed.  
`recipients` | The email addresses of the envelope recipients.  
**Note** : If the envelope has a workflow definition and the `workflowStatus` is `paused`, the envelope will not be sent immediately, even if the envelope’s `status` is `sent`. There are many ways to use envelopes. You can create and send an envelope with a single API request, or you can use several API requests to create, populate, and send envelopes.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Cdse mode | Reserved for DocuSign.  
Change routing order | When true, users can define the routing order of recipients while sending documents for signature.  
Completed documents only | Reserved for DocuSign.  
Merge roles on draft | When set to **true** , template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the `status` field is set to `created`.) **Note** : DocuSign recommends that this parameter should be set to **true** whenever you create a draft envelope with multiple templates.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Custom Fields Post Custom Fields
`<docusign:create-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>`
Updates the envelope custom fields for draft and in-process envelopes. You may assign up to three envelope custom fields to an envelope. This limit does not include account (document) custom fields. Each custom field used in an envelope must have a unique name. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Document Fields Post Document Fields
`<docusign:create-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>`
Creates custom document fields in an existing envelope document. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Responsive Html Post Document Responsive Html Preview
`<docusign:create-v21-accounts-envelopes-documents-responsive-html-preview-by-account-id-envelope-id-document-id>`
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.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Tabs Post Document Tabs
`<docusign:create-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>`
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Templates Post Document Templates
`<docusign:create-v21-accounts-envelopes-documents-templates-by-account-id-envelope-id-document-id>`
Adds templates to a document in the specified envelope. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Preserve template recipient | Preserve template recipient  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Email Settings Post Email Settings
`<docusign:create-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>`
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.
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 Copy or Certified Delivery recipient type.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Lock Post Envelope Lock
`<docusign:create-v21-accounts-envelopes-lock-by-account-id-envelope-id>`
This method locks the specified envelope and sets the time until the lock expires to prevent other users or recipients from changing the envelope. The response to this request returns a `lockToken` parameter. You must use the `lockToken` to update or delete an existing lock. You must also include the `lockToken` in the header for every PUT call that you make on the envelope while it is locked. If you do not include the `lockToken`, the system returns the following error:
`{ "errorCode": "EDIT_LOCK_NOT_LOCK_OWNER", "message": "The user is not the owner of the lock. The template is locked by another user or in another application" }`
**Note** : Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Post Recipients
`<docusign:create-v21-accounts-envelopes-recipients-by-account-id-envelope-id>`
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`.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Resend envelope | When set to **true** , resends the envelope to the recipients that you specify in the request body. You use this parameter to resend the envelope to a recipient who deleted the original email notification. **Note** : Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Post Recipient Proof File Resource Token
`<docusign:create-v21-accounts-envelopes-recipients-identity-proof-token-by-account-id-envelope-id-recipient-id>`
Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The account ID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Recipient Id | The `recipientIdGuid`.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Post Recipient Tabs
`<docusign:create-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>`
Adds one or more tabs for a recipient. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Recipient Id | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Responsive Html Post Responsive Html Preview
`<docusign:create-v21-accounts-envelopes-responsive-html-preview-by-account-id-envelope-id>`
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. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Templates Post Envelope Templates
`<docusign:create-v21-accounts-envelopes-templates-by-account-id-envelope-id>`
Adds templates to the specified envelope. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
Preserve template recipient | Preserve template recipient  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Envelope Transfer Rules Post Envelope Transfer Rules
`<docusign:create-v21-accounts-envelopes-transfer-rules-by-account-id>`
Creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties:
  * `eventType`
  * `fromGroups`
  * `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.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/transfer_rules endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Views Post Envelope Correct View
`<docusign:create-v21-accounts-envelopes-views-correct-by-account-id-envelope-id>`
Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. **Important** : Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.
**Note** : You can revoke this URL by making the DELETE call to the same URL with no request body. Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access. If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:
  * Configure each sender to have their own individual user account to use this API method.
  * Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.


This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Views Post Envelope Edit View
`<docusign:create-v21-accounts-envelopes-views-edit-by-account-id-envelope-id>`
Returns a URL that enables 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.
Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.
You can revoke this URL by making the DELETE call to the same URL with no request body.
Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.
If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:
  * Configure each sender to have their own individual user account to use this API method.
  * Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.
## Views Post Envelope Edit View
`<docusign:create-v21-accounts-envelopes-views-edit-by-account-id-envelope-id>`
Returns a URL that enables 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.
Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.
You can revoke this URL by making the DELETE call to the same URL with no request body.
Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.
If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:
  * Configure each sender to have their own individual user account to use this API method.
  * Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.


This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Views Post Envelope Recipient View
`<docusign:create-v21-accounts-envelopes-views-recipient-by-account-id-envelope-id>`
Returns a URL that enables you to embed the recipient view of the DocuSign UI in your applications. If the recipient is a signer, then the view will provide the signing ceremony.
**Note** : Please redirect the client to the URL. iFrames should not be used, especially if the recipient is using a mobile or tablet. This method is only used with envelopes in the `sent` status. Your application is responsible for authenticating the identity of the recipient or signer when you use this method. Use the parameters `assertionId`, `authenticationInstant`, `authenticationMethod`, `clientUserId`, and `securityDomain` to record information on how the recipient was authenticated. At a minimum, `authenticationMethod` and `clientUserId` are required. The information that you provide is included in the envelope’s certificate of completion.
### Redirects
After the signer completes or ends the signing ceremony, DocuSign will redirect the user’s browser back to your app via the `returnUrl` that you supply. (The user is redirected through a different subdomain, depending on the region of the account sending the envelope. Verify your domain allowlist.)
#### The event status parameter
DocuSign appends an `event` query parameter to the URL with the outcome of the signing ceremony. Your app can use this event parameter to determine the next step for the envelope. Do not fetch the envelope status by using Envelopes::get or a similar method because doing so could break the DocuSign rule against polling.
**Note** : Because a user can cancel redirection, close their browser after signing, or spoof the landing URL. Hitting the `ReturnUrl` should not be the single source of truth for envelope status for your integration.
#### The URL is time-limited
The URL returned by this method is valid for one use, and you must use or display it within a couple of minutes after it is generated. AFter the recipient is redirected to the recipient view, they must interact with the DocuSign system periodically or their session will time out. Because the URL is time-limited, it should not be stored or sent through email. After you receive it, immediately redirect the user’s browser to the URL. If you want to invite someone to an embedded signing session via email, the email invitation’s URL must be to your application. When invoked, your app should request a recipientView URL from DocuSign and then redirect the signer to that URL.
### Maintaining State
After the recipient completes the recipient view (or signing ceremony), they are redirected to your application. Your application can recover state information about the transaction by storing information in a cookie, or by including query parameters in the `returnUrl` field, for example `https://myapp.eg.com/docusign_return?myState=12345`. When the user is redirected to your app, the `event` query parameter will be appended. In this example, prevent spoofing by not using a guessable value as the state value.
**Note** : You can revoke the URL by making the DELETE call to the same URL with no request body.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Views Post Envelope Recipient Preview
`<docusign:create-v21-accounts-envelopes-views-recipient-preview-by-account-id-envelope-id>`
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.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Views Post Envelope Sender View
`<docusign:create-v21-accounts-envelopes-views-sender-by-account-id-envelope-id>`
Returns a URL that enables you to embed the sender view of the DocuSign UI in your applications. The returned URL can only be redirected to immediately after it is generated. It can only be used once. Therefore, request the URL immediately before you redirect your user to it.
For the best user experience, don’t use an iFrame. For iOS devices DocuSign recommends using a WebView. Multiple solutions are available for maintaining your client state. After the user has completed the sending view, the browser is redirected to the `returnUrl` supplied. By default, if the envelope already contains one or more documents, DocuSign will initially show the document tagging view when you redirect to the URL.
To start with the envelope’s recipients and documents view instead, examine the URL in the method’s response. Then change the query parameter from `send=1` to `send=0` to start with the recipients/documents view.
**Note** : You can revoke the URL by making the DELETE call to the same URL with no request body.
Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.
If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:
  * Configure each sender to have their own individual user account to use this API method.
  * Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.


This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Views Post Envelope Recipient Shared View
`<docusign:create-v21-accounts-envelopes-views-shared-by-account-id-envelope-id>`
Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. 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, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.
You can revoke this URL by making the DELETE call to the same URL with no request body.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Envelope Id | The envelope’s GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Groups Post Groups
`<docusign:create-v21-accounts-groups-by-account-id>`
Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/groups endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Permission Profiles Post Permission Profiles
`<docusign:create-v21-accounts-permission-profiles-by-account-id>`
This method creates a new permission profile for an account. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/permission_profiles endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  *
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Power Forms Post Power Form
`<docusign:create-v21-accounts-powerforms-by-account-id>`
This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, based on the `templateId` in the request body. PowerForms that you create from a template are referred to as **web PowerForms**.
The RADmin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a **PDF PowerForm**). However, PDF PowerForms are deprecated and are not supported in the API.
A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm **initiator**.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.
### Signing modes
You can use one of the following signing modes for a PowerForm: This mode verifies the recipient’s identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.
Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` `direct`. This mode does not require any verification.
After a recipient enters their email address on the landing page and clicks **Begin Signing** , a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient’s identity by using email authentication, DocuSign strongly recommends that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient’s identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). **Note** : In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.
### Redirect URLs
You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed).
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/powerforms endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Reports In Product Post Report In Product Create
`<docusign:create-v21-accounts-reports-by-account-id>`
Reports In Product Post Report In Product Create This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/reports endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## BCCEmail Archive Post BCCEmail Archive
`<docusign:create-v21-accounts-settings-bcc-email-archives-by-account-id>`
This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates). The only property that you must set in the request body is the BCC email address that you want to use.
**Note** : An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/settings/bcc_email_archives endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Account Signatures Post Account Signatures
`<docusign:create-v21-accounts-signatures-by-account-id>`
Account Signatures Post Account Signatures This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/signatures endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Decode only | Decode only  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Signing Groups Post Signing Groups
`<docusign:create-v21-accounts-signing-groups-by-account-id>`
Creates one or more signing groups. Multiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. An account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members. Signing groups can be used by any account user. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/signing_groups endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Tabs Post Tab Definitions
`<docusign:create-v21-accounts-tab-definitions-by-account-id>`
Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/tab_definitions endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Templates Post Templates
`<docusign:create-v21-accounts-templates-by-account-id>`
Creates one or more template definitions, using a multipart request for each template. Templates help streamline the sending process when you frequently send the same or similar documents, or send different documents to the same group of people. When you create a template, you define placeholder roles. Rather than specifying a person, you specify a role that regularly participates in a transaction that uses the template. Then, when you create or send an envelope based on the template, you assign actual recipients to the template roles. The recipients automatically inherit all of the workflow that is defined for that role in the template, such as the tabs and routing information. For code examples and more information, see REST API Templates.
### Template Email Subject Merge Fields
Placeholder roles have associated merge fields that personalize the email notification that DocuSign sends. For example, the template automatically personalizes the email message by adding placeholders for the recipient’s name and email address within the email subject line, based on the recipient’s role. When the 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 find out who the recipient is.
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 you expect the recipient name or email to be long, you should consider placing the merge field at the start of the email subject.
To insert a recipient’s name into the subject line, add the following text in the `emailSubject` property when you create the 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` property when you create the template or send an envelope from the template:
`[[<roleName>_Email]]`
Example:
`"emailSubject":"[[Signer 1_Email]], Please sign this NDA",`
In these examples, the role name specified in the template is “Signer 1”. When the envelope is sent, the placeholder will be dynamically substituted with the recipient’s name or email.
### Creating multiple templates
To create multiple templates, you provide a zip file of JSON files. You can also use the Templates::ListTemplates method with the `is_download` query parameter to download a zip file containing your existing templates and use that as a guide. The API supports both .zip and .gzip file formats as input.
You also need to set the following headers:
  * `Content-Length`
  * `Content-Type`
  * `Content-Disposition`


Example:
`Content-Length: 71068` `Content-Type: application/zip` `Content-Disposition: file; filename="DocuSignTemplates_Nov_25_2019_20_40_21.zip"; fileExtension=.zip`
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | (Required) The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  *
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Custom Fields Post Template Custom Fields
`<docusign:create-v21-accounts-templates-custom-fields-by-account-id-template-id>`
Creates custom document fields in an existing template document. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Template Id | The ID of the template.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Document Fields Post Template Document Fields
`<docusign:create-v21-accounts-templates-documents-fields-by-account-id-template-id-document-id>`
Creates custom document fields in an existing template document. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Template Id | The ID of the template.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Responsive Html Post Template Document Responsive Html Preview
`<docusign:create-v21-accounts-templates-documents-responsive-html-preview-by-account-id-template-id-document-id>`
Creates a preview of the responsive, HTML version of a specific template 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.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Template Id | The ID of the template.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Tabs Post Template Document Tabs
`<docusign:create-v21-accounts-templates-documents-tabs-by-account-id-template-id-document-id>`
This method creates Template Document Tabs. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Document Id | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab.  
Template Id | The ID of the template.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Lock Post Template Lock
`<docusign:create-v21-accounts-templates-lock-by-account-id-template-id>`
Locks the specified template and sets the time until the lock expires to prevent other users or recipients from changing the template. The response to this request returns a `lockToken` parameter. You must use the `lockToken` to update or delete an existing lock. You must also include the `lockToken` in the header for every PUT call that you make on the template while the template is locked. If you do not include the `lockToken`, the system returns the following error:
`{ "errorCode": "EDIT_LOCK_NOT_LOCK_OWNER", "message": "The user is not the owner of the lock. The template is locked by another user or in another application" }`
Users must have envelope locking capability enabled to use this function (the userSetting property `canLockEnvelopes` must be set to **true** for the user).   
---  
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/lock endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Template Id | The ID of the template.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Post Template Recipients
`<docusign:create-v21-accounts-templates-recipients-by-account-id-template-id>`
Adds one or more recipients to a template. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Template Id | The ID of the template.  
Resend envelope | When set to **true** , resends the envelope to the recipients that you specify in the request body. You use this parameter to resend the envelope to a recipient who deleted the original email notification. **Note** : Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Recipients Post Template Recipient Tabs
`<docusign:create-v21-accounts-templates-recipients-tabs-by-account-id-template-id-recipient-id>`
Adds one or more tabs for a recipient. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Recipient Id | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.  
Template Id | The ID of the template.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Responsive Html Post Template Responsive Html Preview
`<docusign:create-v21-accounts-templates-responsive-html-preview-by-account-id-template-id>`
Creates a preview of the [responsive](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/api-overview), HTML versions of all of the documents associated with a template. 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.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Template Id | The ID of the template.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Views Post Template Edit View
`<docusign:create-v21-accounts-templates-views-edit-by-account-id-template-id>`
This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/views/edit endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Template Id | The ID of the template.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  *
| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Views Post Template Recipient Preview
`<docusign:create-v21-accounts-templates-views-recipient-preview-by-account-id-template-id>`
This method returns a URL for a template 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. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
Template Id | The ID of the template.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE


## Users Post Users
`<docusign:create-v21-accounts-users-by-account-id>`
Adds new users to an account. The body of this request is an array of `newUsers` objects. For each new user, you must provide at least the `userName` and `email` properties. The `userSettings` property specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email is in French because the `locale` is set to `fr`.
```
POST /restapi/v2.1/accounts/{accountId}/users
Content-Type: application/json
{
	"newUsers": [{
		"userName": "Claire Horace",
		"email": "claire@example.com"
	}, {
		"userName": "Tal Mason",
		"email": "talmason@example.com",
		"company": "TeleSel",
		"userSettings": {
			"locale": "fr",
			"canSendEnvelope": true
		}
	}]
}
```

A successful response is a `newUsers` array with information about the newly created users. If there was a problem in creating a user, that user entry will contain an `errorDetails` property that describes what went wrong.
```
{
	"newUsers": [{
		"userId": "18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade",
		"uri": "/users/18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade",
		"email": "claire@example.com",
		"userName": "Claire Horace",
		"createdDateTime": "0001-01-01T08:00:00.0000000Z",
		"errorDetails": {
			"errorCode": "USER_ALREADY_EXISTS_IN_ACCOUNT",
			"message": "Username and email combination already exists for this account."
		}
	}, {
		"userId": "be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33",
		"uri": "/users/be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33",
		"email": "talmason@example.com",
		"userName": "Tal Mason",
		"userStatus": "ActivationSent",
		"createdDateTime": "2020-05-26T23:25:30.7330000Z"
	}]
}
```

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/users endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Account Id | The external account number (int) or account ID GUID.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Stream
  * Repeatable File Store Stream
  * non-repeatable-stream

| Configures how Mule processes streams. The default is to use repeatable streams.  
Custom Query Parameters  
Custom Headers  
Response Timeout | Timeout for the request to the remote service.  
Response Timeout Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit for the Response Timeout field.  
Streaming Type |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.  
Target Variable | Name of the variable that stores the operation’s output.  
Target Value | Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. | #[payload]  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors  
### Output
Attributes Type |  HTTP Response Attributes  
---|---  
### For Configurations
  * 

### Throws
  * DOCUSIGN:BAD_REQUEST
  * DOCUSIGN:CLIENT_ERROR
  * DOCUSIGN:CONNECTIVITY
  * DOCUSIGN:INTERNAL_SERVER_ERROR
  * DOCUSIGN:NOT_ACCEPTABLE
  * DOCUSIGN:NOT_FOUND
  * DOCUSIGN:RETRY_EXHAUSTED
  * DOCUSIGN:SERVER_ERROR
  * DOCUSIGN:SERVICE_UNAVAILABLE
  * DOCUSIGN:TIMEOUT
  * DOCUSIGN:TOO_MANY_REQUESTS
  * DOCUSIGN:UNAUTHORIZED
  * DOCUSIGN:UNSUPPORTED_MEDIA_TYPE