DocuSign Connector 1.1 Reference | MuleSoft Documentation
| 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  
### For Configurations
  * 

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


## User Custom Settings Get Custom Settings
`<docusign:get-v21-accounts-users-custom-settings-by-account-id-user-id>`
Retrieves a list of custom user settings for a single user. Custom settings provide a flexible way to store and retrieve custom user information that can be used in your own system.
**Note** : Custom user settings are not the same as user account settings.
### Getting Grouped Custom User Settings
If the custom user settings you want to retrieve are grouped, you must include the following information in the header, after Content-Type, in the request: `X-DocuSign-User-Settings-Key:group_name` Where the `group_name` is your designated name for the group of customer user settings. If the extra header information is not included, only the custom user settings that were added without a group are retrieved.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/custom_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.  
The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.  
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


## User Profile Get Profile
`<docusign:get-v21-accounts-users-profile-by-account-id-user-id>`
Retrieves the user profile information, the privacy settings and personal information (address, phone number, etc.) for the specified user. The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the specified account.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/profile 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 ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.  
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


## User Profile Image Get User Profile Image
`<docusign:get-v21-accounts-users-profile-image-by-account-id-user-id>`
Retrieves the user profile picture for the specified user. The image is returned in the same format as uploaded. The userId parameter specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the specified account. If successful, the response returns a 200 - OK and the user profile image.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/profile/image 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 ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.  
encoding | Reserved for DocuSign.  
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


## User Settings Get User Settings
`<docusign:get-v21-accounts-users-settings-by-account-id-user-id>`
Retrieves a list of the account settings and email notification information for the specified user. The response returns the account setting name/value information and the email notification settings for the specified user.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/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.  
The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.  
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


## User Signatures Get User Signatures
`<docusign:get-v21-accounts-users-signatures-by-account-id-user-id>`
This method retrieves the signature definitions for the user that you specify. The `userId` parameter specified in the endpoint must match the authenticated user’s user ID, and the user must be a member of the account.
The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example, encode "Bob Smith" as "Bob%20Smith".
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/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.  
The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.  
Stamp type | The type of stamps to return. Valid values are: - `signature`: Returns information about signature images only. The default value. - `stamp`: Returns information about eHanko and custom stamps only. - null  
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


## User Signatures Get User Signature
`<docusign:get-v21-accounts-users-signatures-by-account-id-user-id-signature-id>`
Retrieves the structure of a single signature with a known signature name. The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.
The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId} 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.  
Signature Id | The ID of the signature being accessed.  
The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.  
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


## User Signatures Get User Signature Image
`<docusign:get-v21-accounts-users-signatures-by-account-id-user-id-signature-id-image-type>`
Retrieves the specified initials image or signature image for the specified user. The image is returned in the same format in which it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId property specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.
The `signatureId` parameter accepts a signature ID or a signature name. DocuSign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example encode "Bob Smith" as "Bob%20Smith".
**Note** : Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType} 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.  
Image Type | Specificies the type of image. Valid values are: - `signature_image` - `initials_image`  
Signature Id | The ID of the signature being accessed.  
The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.  
Include chrome | When **true** , the chrome (or frame containing the added line and identifier) is included with the signature image.  
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


## Watermark Get Watermark
`<docusign:get-v21-accounts-watermark-by-account-id>`
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/watermark 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.  
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


## Workspace Get Workspaces
`<docusign:get-v21-accounts-workspaces-by-account-id>`
Gets information about the Workspaces that have been created. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/workspaces 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.  
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


## Workspace Get Workspace
`<docusign:get-v21-accounts-workspaces-by-account-id-workspace-id>`
Retrieves properties about a workspace given a unique workspaceId. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/workspaces/{workspaceId} 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.  
Workspace Id | The ID of the workspace.  
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


## Workspace Folder Get Workspace Folder
`<docusign:get-v21-accounts-workspaces-folders-by-account-id-workspace-id-folder-id>`
This method returns the contents of a workspace folder, which can include sub-folders and files. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId} 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.  
Folder Id | The ID of the folder.  
Workspace Id | The ID of the workspace.  
The maximum number of results to return.  
Include thumbnails | When set to **true** , the response returns thumbnails. The default is **false**.  
Include user detail | When set to **true** , the response includes extended details about the user. The default is **false**.  
Include sub folders | When set to **true** , the response includes information about the sub-folders of the current folder. The default is **false**.  
Include files | When set to **true** , the response includes file information (in addition to folder information). The default is **false**.  
Start position | The position within the total result set from which to start returning values.  
Workspace user ID | If set, the response only includes results associated with the `userId` that you specify.  
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


## Workspace File Get Workspace File
`<docusign:get-v21-accounts-workspaces-folders-files-by-account-id-workspace-id-folder-id-file-id>`
This method returns a binary version of a file in a workspace. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId} 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 ID of the file.  
Folder Id | The ID of the folder.  
Workspace Id | The ID of the workspace.  
Is download | When set to **true** , the `Content-Disposition` header is set in the response. The value of the header provides the filename of the file. The default is **false**.  
Pdf version | When set to **true** the file is returned in PDF format.  
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


## Workspace File Pages Get Workspace File Pages
`<docusign:get-v21-accounts-workspaces-folders-files-pages-by-account-id-workspace-id-folder-id-file-id>`
This method returns a workspace file as rasterized pages. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId}/pages 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 ID of the file.  
Folder Id | The ID of the folder.  
Workspace Id | The ID of the workspace.  
Max width | Sets the maximum width of the returned images in pixels.  
The maximum number of results to return.  
Max height | Sets the maximum height of the returned images in pixels.  
The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.  
Start position | The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| 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  
### For Configurations
  * 

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


## Billing Plans Get Billing Plans
`<docusign:get-v21-billing-plans>`
Retrieves a list of the billing plans associated with a distributor. This operation makes an HTTP GET request to the /v2.1/billing_plans endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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


## Billing Plans Get Billing Plan
`<docusign:get-v21-billing-plans-by-billing-plan-id>`
Retrieves the billing plan details for the specified billing plan ID. This operation makes an HTTP GET request to the /v2.1/billing_plans/{billingPlanId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Billing Plan Id | The ID of the billing plan being accessed.  
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


## Notary Get Notary
`<docusign:get-v21-current-user-notary>`
Gets settings for a notary user. The current user must be a notary. This operation makes an HTTP GET request to the /v2.1/current_user/notary endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Include jurisdictions | If **true** , the response will include a `jurisdiction` property that contains an array of all supported jurisdictions for the current user.  
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


## Notary Journals Get Notary Journals
`<docusign:get-v21-current-user-notary-journals>`
This operation makes an HTTP GET request to the /v2.1/current_user/notary/journals endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
The maximum number of results to return.  
Search text | Use this parameter to search for specific text.  
Start position | The position within the total result set from which to start returning values. The value **thumbnail** may be used to return the page image.  
Output Mime Type | The mime type of the payload that this operation outputs.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
Streaming Strategy | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

| 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  
### For Configurations
  * 

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


## Notary Jurisdictions Get Notary Jurisdictions
`<docusign:get-v21-current-user-notary-jurisdictions>`
Returns a list of jurisdictions that the notary is registered in. The current user must be a notary. This operation makes an HTTP GET request to the /v2.1/current_user/notary/jurisdictions endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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


## Notary Jurisdictions Get Notary Jurisdiction
`<docusign:get-v21-current-user-notary-jurisdictions-by-jurisdiction-id>`
Gets a jurisdiction object for the current user. The following restrictions apply:
  * The current user must be a notary.
  * The `jurisdictionId` must be a jurisdiction that the notary is registered for.
| 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


## Notary Jurisdictions Get Notary Jurisdiction
`<docusign:get-v21-current-user-notary-jurisdictions-by-jurisdiction-id>`
Gets a jurisdiction object for the current user. The following restrictions apply:
  * The current user must be a notary.
  * The `jurisdictionId` must be a jurisdiction that the notary is registered for.


This operation makes an HTTP GET request to the /v2.1/current_user/notary/jurisdictions/{jurisdictionId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Jurisdiction Id | The ID of the jurisdiction. The following jurisdictions are supported: - `5 - California` - `6 - Colorado` - `9 - Florida` - `10 - Georgia` - `12 - Idaho` - `13 - Illinois` - `14 - Indiana` - `15 - Iowa` - `17 - Kentucky` - `23 - Minnesota` - `25 - Missouri` - `30 - New Jersey` - `32 - New York` - `33 - North Carolina` - `35 - Ohio` - `37 - Oregon` - `38 - Pennsylvania` - `40 - South Carolina` - `43 - Texas` - `44 - Utah` - `47 - Washington` - `48 - West Virginia` - `49 - Wisconsin` - `62 - Florida Commissioner of Deeds`  
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


## Password Rules Get Password Rules
`<docusign:get-v21-current-user-password-rules>`
This operation makes an HTTP GET request to the /v2.1/current_user/password_rules endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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


## APIRequest Log Get Request Logs
`<docusign:get-v21-diagnostics-request-logs>`
Retrieves a list of log entries as a JSON or xml object or as a zip file containing the entries. If the Accept header is set to application/zip, the response is a zip file containing individual text files, each representing an API request. If the Accept header is set to `application/json` or `application/xml`, the response returns list of log entries in either JSON or XML. An example JSON response body is shown below.
This operation makes an HTTP GET request to the /v2.1/diagnostics/request_logs endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
encoding | Reserved for DocuSign.  
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


## APIRequest Log Get Request Log
`<docusign:get-v21-diagnostics-request-logs-by-request-log-id>`
Retrieves information for a single log entry.
**Request** The `requestLogfId` property can be retrieved by getting the list of log entries. The Content-Transfer-Encoding header can be set to base64 to retrieve the API request/response as base 64 string. Otherwise the bytes of the request/response are returned.
**Response** If the Content-Transfer-Encoding header was set to base64, the log is returned as a base64 string.
This operation makes an HTTP GET request to the /v2.1/diagnostics/request_logs/{requestLogId} endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Request Log Id | Request Log Id  
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


## APIRequest Log Get Request Log Settings
`<docusign:get-v21-diagnostics-settings>`
Retrieves the current API request logging setting for the user and remaining log entries.
**Response** The response includes the current API request logging setting for the user, along with the maximum log entries and remaining log entries.
This operation makes an HTTP GET request to the /v2.1/diagnostics/settings endpoint.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
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


## Unauthorize
`<docusign:unauthorize>`
Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without doing the authorization dance again.
### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | Name of the configuration to use  
Resource Owner Id | ID of the resource owner which access should be invalidated  
Config Ref |  ConfigurationProvider | Name of the configuration to use to execute this component  
### For Configurations
  * 

## Billing Plan Put Billing Plan
`<docusign:update-v21-accounts-billing-plan-by-account-id>`
Updates the billing plan information, billing address, and credit card information for the specified account. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/billing_plan 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.  
Preview billing plan | When set to **true** , updates the account using a preview billing plan.  
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


## Billing Plan Put Downgrade Account Billing Plan
`<docusign:update-v21-accounts-billing-plan-downgrade-by-account-id>`
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/billing_plan/downgrade 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


## Purchased Envelopes Put Purchased Envelopes
`<docusign:update-v21-accounts-billing-plan-purchased-envelopes-by-account-id>`
Reserved: At this time, this endpoint is limited to DocuSign internal use only. Completes the purchase of envelopes for your account. The actual purchase is done as part of an internal workflow interaction with an envelope vendor.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/billing_plan/purchased_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.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
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


## Brand Put Brand
`<docusign:update-v21-accounts-brands-by-account-id-brand-id>`
This method updates an account brand.
**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 PUT request to the /v2.1/accounts/{accountId}/brands/{brandId} 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.  
Brand Id | The ID of the brand.  
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


## Brand Logo Put Brand Logo
`<docusign:update-v21-accounts-brands-logos-by-account-id-brand-id-logo-type>`
This method updates a single brand logo. You pass in the new version of the resource in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="logo.jpg"`
**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 PUT request to the /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} 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.  
Brand Id | The ID of the brand.  
Logo Type | The type of logo. Valid values are: - `primary` - `secondary` - `email`  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
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


## Brand Resources Put Brand Resources
`<docusign:update-v21-accounts-brands-resources-by-account-id-brand-id-resource-content-type>`
This method updates a branding resource file. You pass in the new version of the resource file in the `Content-Disposition` header. Example: `Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"`
**Note** : Branding for either signing or sending must be enabled for the account (`canSelfBrandSend` , `canSelfBrandSign`, or both of these account settings must be **true**).
**Important** : Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed. When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType} 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.  
Brand Id | The ID of the brand.  
Resource Content Type | The type of brand resource file that you are updating. Valid values are: - `sending` - `signing` - `email` - `signing_captive`  
File Xml - Body | The content of the 'fileXml' part. | #[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 Put Bulk Send List
`<docusign:update-v21-accounts-bulk-send-lists-by-account-id-bulk-send-list-id>`
This method replaces the definition of an existing bulk send list. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId} 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
| 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 Put Chunked Uploads
`<docusign:update-v21-accounts-chunked-uploads-by-account-id-chunked-upload-id>`
This method checks the integrity of a chunked upload and then commits it. When this request is successful, the chunked upload is then ready to be referenced in other API calls. If the request is unsuccessful, ensure that you have uploaded all of the parts by using the Update method.
**Note** : After you commit a chunked upload, it no longer accepts additional parts.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId} 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.  
Chunked Upload Id | (Required) The ID of the chunked upload to commit.  
(Required) You must use this query parameter with the value `commit`, which affirms the request to validate and prepare the chunked upload for use with other API calls.  
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 Put Chunked Upload Part
`<docusign:update-v21-accounts-chunked-uploads-by-account-id-chunked-upload-id-chunked-upload-part-seq>`
Adds a chunk or part to an existing chunked upload. After you use the Create method to initiate a new chunked upload and upload the first part, use this method to upload subsequent parts. For simplicity, DocuSign recommends that you upload the parts in their sequential order ( 1,2, 3, 4, etc.). The Create method adds the first part and assigns it the `sequence` value `0`. As a result, DocuSign recommends that you start with a `sequence` value of `1` when you use this method, and continue uploading parts contiguously until you have uploaded the entirety of the original content to DocuSign.
Example: `PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/1 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/2 PUT /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/3`
**Note** : You cannot replace a part that DocuSign has already received, or add parts to a chunked upload that is already successfully committed.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId}/{chunkedUploadPartSeq} 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.  
Chunked Upload Id | The ID of the chunked upload.  
Chunked Upload Part Seq | The sequence or order of the part in the chunked upload. By default, the sequence of the first part that is uploaded as part of the Create request is `0`. **Note** : You can add parts out of order. However, the chunked upload must consist of a contiguous series of one or more parts before you can successfully commit it.  
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 Put Connect Configuration
`<docusign:update-v21-accounts-connect-by-account-id>`
Updates the specified DocuSign Connect configuration in your account.
**Note** : Connect must be enabled for your account to use this function. This cannot be used to update Connect configurations for Box, eOriginal, or Salesforce.
This operation makes an HTTP PUT 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


## Connect Publish Put Connect Retry
`<docusign:update-v21-accounts-connect-envelopes-retry-queue-by-account-id>`
Republishes Connect information for the specified set of envelopes. The primary use is to republish Connect post failures by including envelope IDs for the envelopes that failed to post in the request. The list of envelope IDs that failed to post correctly can be retrieved by calling to `Connect::listEventLogs` retrieve the failure log.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/connect/envelopes/retry_queue 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


## Connect Publish Put Connect Retry By Envelope
`<docusign:update-v21-accounts-connect-envelopes-retry-queue-by-account-id-envelope-id>`
Republishes Connect information for the specified envelope. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/connect/envelopes/{envelopeId}/retry_queue 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`  
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


## Consumer Disclosure Put Consumer Disclosure
`<docusign:update-v21-accounts-consumer-disclosure-by-account-id-lang-code>`
Account administrators can use this method to perform the following tasks:
  * Customize values in the default disclosure.
  * Switch to a custom disclosure that uses your own text and HTML formatting.
  * Change values in your existing consumer disclosure.


To specify the signer language version of the disclosure that you are updating, use the optional `langCode` query parameter.
**Note** : Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version.
### Updating the default disclosure
When you update the default disclosure, you can edit all properties except for the following ones:
  * `accountEsignId`: This property is read only.
  * `custom`: The default value is **false**. Editing this property causes the default disclosure to switch to a custom disclosure.
  * `esignAgreement`: This property is read only.
  * `esignText`: You cannot edit this property when `custom` is set to **false**. The API returns a 200 OK HTTP response, but does not update the `esignText`.
  * Metadata properties: These properties are read only.


**Note** : The text of the default disclosure is always in English.
### Switching to a custom disclosure
To switch to a custom disclosure, set the `custom` property to **true** and customize the value for the `eSignText` property. You can also edit all of the other properties except for the following ones:
  * `accountEsignId`: This property is read only.
  * `esignAgreement`: This property is read only.
  * Metadata properties: These properties are read only.


**Note** : When you use a custom disclosure, you can create versions of it in different signer languages and se the `langCode` parameter to specify the signer language version that you are updating.
**Important** : When you switch from a default to a custom disclosure, note the following information:
  * You will not be able to return to using the default disclosure.
  * Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.


### Updating a custom disclosure
When you update a custom disclosure, you can update all of the properties except for the following ones:
  * `accountEsignId`: This property is read only.
  * `esignAgreement`: This property is read only.
  * Metadata properties: These properties are read only.


**Important** : Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/consumer_disclosure/{langCode} 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.  
Lang Code | (Optional) The code for the signer language version of the disclosure that you want to update. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`.  
Include metadata | (Optional) When set to true, the response includes metadata indicating which properties 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
  * 

### 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 Put Contacts
`<docusign:update-v21-accounts-contacts-by-account-id>`
This method updates one or more contacts associated with an account. This operation makes an HTTP PUT 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
| 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 Put Account Custom Fields
`<docusign:update-v21-accounts-custom-fields-by-account-id-custom-field-id>`
This method updates an existing account custom field. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/custom_fields/{customFieldId} 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.  
Custom Field Id | The ID of the custom field.  
Apply to templates | Apply to 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


## Attachments Put Attachments
`<docusign:update-v21-accounts-envelopes-attachments-by-account-id-envelope-id>`
Supported attachment formats include: .asp, .bmp, .csv, .doc, .docm, .docx, .dot, .dotm, .dotx, .gif, .htm, .html, .jpeg, .jpg, .msg, .pdf, .png, .pot, .potx, .pps, .ppt, .pptm, .pptx, .ps, .rtf, .tif, .tiff, .txt, .wpd, .xls, .xlsm, .xlsx, .xml, and .xps. For more information about supported file formats, see Supported File Formats.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments 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


## Attachments Put Attachment
`<docusign:update-v21-accounts-envelopes-attachments-by-account-id-envelope-id-attachment-id>`
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId} 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.  
Attachment Id | The unique identifier for the attachment.  
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
  *
| 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


## Envelopes Put Envelope
`<docusign:update-v21-accounts-envelopes-by-account-id-envelope-id>`
This method enables you to make changes to an envelope. You can use it to:
  * Send a draft envelope * Void an in-process envelope
  * Modify a draft envelope * Purge documents and envelope metadata from the DocuSign platform Although the request body for this method is a complete envelope definition, you only need to provide the properties that you’re updating.


### Sending a Draft Envelope
To send a draft envelope, include the following code in the request body:
`{ "status": "sent" }`
You can attach a workflow before sending the envelope:
`{ "status": "sent", "workflow": { "workflowSteps": [ { "action": "pause_before", "description": "pause_before routing order 2", "itemId": 2, "triggerOnItem": "routing_order" } ] } }`
### Working with Workflows
To unpause a workflow, the request body should include this: `json { "workflow": { "workflowStatus": "in_progress" } } `
### Voiding an In-Process Envelope
To void an in-process envelope, include the following code in the request body:
`{ "status": "voided", "voidedReason": "The reason for voiding the envelope" }`
### Modifying Envelope Email Information
To change the email subject and message of a draft envelope, include the following code in the request body:
`{ "emailSubject": "new email subject", "emailBlurb": "new email message" }`
### Purging Documents from DocuSign
To place only the documents in the purge queue, leaving any corresponding attachments and tabs in the DocuSign platform, set the `purgeState` property to `documents_queued`.
`{ "purgeState": "documents_queued" }`
To place documents, attachments, and tabs in the purge queue, set the `purgeState` property to `documents_and_metadata_queued`.
`{ "purgeState": "documents_and_metadata_queued" }`
You can purge documents only from completed envelopes that are not marked as the authoritative copy. The user requesting the purge must have permission to purge documents and must be the sender or be acting on behalf of the sender. When the purge request is initiated the items to be purged are placed in the purge queue for deletion in 14 days.
The sender and all recipients with DocuSign accounts associated with the envelope get an email notification the documents will be deleted in 14 days. The notification contains a link to the documents. A second email notification is sent 7 days later. At the end of the 14-day period the documents are deleted from the system. Recipients without DocuSign accounts do not receive email notifications.
If your account has a Document Retention policy, envelope documents are automatically placed in the purge queue, and notification emails are sent at the end of the retention period. Setting a Document Retention policy is the same as setting a schedule for purging documents.
### Removing Documents from the Purge Queue
To remove documents from the purge queue, include the following code in the request body: `{ "purgeState": "documents_dequeued" }`
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId} 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`  
Advanced update | When set to **true** , allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.  
Resend envelope | When set to **true** , sends the specified envelope again.  
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 Put Custom Fields
`<docusign:update-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>`
Updates the envelope custom fields in draft and in-process envelopes. Each custom field used in an envelope must have a unique name. This operation makes an HTTP PUT 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
| 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


## Documents Put Documents
`<docusign:update-v21-accounts-envelopes-documents-by-account-id-envelope-id>`
Adds one or more documents to an existing envelope document.
**Note** : When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes. If the file name of a document contains unicode characters, you need to include a `Content-Disposition` header.
Example: **Header** : `Content-Disposition` **Value** : `file; filename=\"name\";fileExtension=ext;documentId=1`
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents 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


## Documents Put Document
`<docusign:update-v21-accounts-envelopes-documents-by-account-id-envelope-id-document-id>`
Adds a document to an existing draft envelope. The bytes of the document make up the body of the request.
**Note** : When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes. If the file name of the document contains unicode characters, you need to include a `Content-Disposition` header.
Example: **Header** : `Content-Disposition` **Value** : `file; filename=\"name\";fileExtension=ext;documentId=1`
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId} 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`  
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 Put Document Fields
`<docusign:update-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>`
Updates existing custom document fields in an existing envelope document. This operation makes an HTTP PUT 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


## Pages Put Page Image
`<docusign:update-v21-accounts-envelopes-documents-pages-page-image-by-account-id-envelope-id-document-id-page-number>`
Rotates page image from an envelope for display. The page image can be rotated to the left or right. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image 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`  
Page Number | The page number being accessed.  
the content to use | #[payload]  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
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 Put Document Tabs
`<docusign:update-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>`
This operation makes an HTTP PUT 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

| 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


## Email Settings Put Email Settings
`<docusign:update-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>`
Updates the existing email override settings for the specified envelope. Note that modifying email settings will only affect email communications that occur after the modification was made. This can also be used to delete an individual email override setting by using an empty string for the value to be deleted.
This operation makes an HTTP PUT 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


## Lock Put Envelope Lock
`<docusign:update-v21-accounts-envelopes-lock-by-account-id-envelope-id>`
Updates the lock duration or the `lockedByApp` property for the specified envelope. The user must match the user specified by the `lockByUser` property, and the integrator key that you pass in must match the integrator key information. You must also include the `X-DocuSign-Edit` header, which contains a `lockToken` that proves ownership of the lock and the `lockDurationInSeconds`. The token that you need for this header is returned in the response to the POST and GET methods.
Example: `X-DocuSign-Edit:{{lockToken}}`
This operation makes an HTTP PUT 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


## Notification Put Envelopes Envelope Id Notification
`<docusign:update-v21-accounts-envelopes-notification-by-account-id-envelope-id>`
This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification 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
| 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 Put Recipients
`<docusign:update-v21-accounts-envelopes-recipients-by-account-id-envelope-id>`
Updates the recipients of a draft envelope or corrects recipient information for an in-process envelope. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the EnvelopeRecipients::Create method). You can also use this method to resend an envelope to a recipient by using the `resend_envelope` option.
### Updating Sent Envelopes
After an envelope has been sent, you can edit only the following properties:
  * `accessCode`
  * `agentCanEditName`
  * `agentCanEditEmail`
  * `customFields`
  * `deliveryMethod`
  * `documentVisibility`
  * `emailNotification`
  * `idCheckConfigurationName`
  * `phoneAuthentication`
  * `recipientType` (For this to work, you must also change the recipient object to match the recipient type.)
  * `requireIdLookup`
  * `routingOrder`
  * `routingOrder`
  * `signingGroupId` (You can change this ID to switch to a different signing group and its corresponding set of recipients.)
  * `smsAuthentication`
  * `suppressEmails`
  * `userName`


This operation makes an HTTP PUT 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`  
Combine same order recipients | When set to **true** , recipients are combined or merged with matching recipients. Recipient matching occurs as part of [template matching](https://docs.docusign.com/DocuSignHelp/Content/automatic-template-matching.htm), and is based on Recipient Role and Routing Order.  
Offline signing | Indicates if offline signing is enabled for the recipient when a network connection is unavailable.  
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 Put Recipients Document Visibility
`<docusign:update-v21-accounts-envelopes-recipients-document-visibility-by-account-id-envelope-id>`
This method updates document visibility for one or more recipients based on the `recipientId` and `visible` values that you include in the request body.
**Note** : A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility 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


## Recipients Put Recipient Document Visibility
`<docusign:update-v21-accounts-envelopes-recipients-document-visibility-by-account-id-envelope-id-recipient-id>`
This method updates document visibility for a recipient.
**Note** : A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility 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


## Recipients Put Recipient Initials Image
`<docusign:update-v21-accounts-envelopes-recipients-initials-image-by-account-id-envelope-id-recipient-id>`
Updates the initials image for a signer that does not have a DocuSign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image 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`.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
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


## Recipients Put Recipient Signature Image
`<docusign:update-v21-accounts-envelopes-recipients-signature-image-by-account-id-envelope-id-recipient-id>`
Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the `CanSendEnvelope` property set to **true** and the `ExpressSendOnly` property in `SendingUser` structure must be set to **false**.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image 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`.  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
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 Put Recipient Tabs
`<docusign:update-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>`
Updates one or more tabs for a recipient in a draft envelope.
**Note** : The Update method can be used if the envelope is not yet complete. To update an existing tab, the request body must include the `tabId`.
This operation makes an HTTP PUT 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
| 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 Put Status
`<docusign:update-v21-accounts-envelopes-status-by-account-id>`
Retrieves envelope statuses for a set of envelopes. You must specify _one_ of the following query parameters:
Parameter | Description  
---|---  
`from_date` | a valid UTC DateTime: `2016-01-01`  
`envelope_ids` | A comma-separated list of envelope IDs or the special value `request_body`  
`transaction_ids` | A comma-separated list of transaction IDs or the special value `request_body`  
When you use the special value `request_body`, the request body looks like this:
`{ "envelopeIds": [ "44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15", "8e26040d-xxxx-xxxx-xxxx-1e29b924d237", "c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95" ] }`
**Note** : Do not omit the request body altogether. The request body must be at least `{}`.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/status 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 maximum number of results to return.  
From to status | The envelope status that you are checking for. Possible values are: - `Changed` (default) - `Completed` - `Created` - `Declined` - `Deleted` - `Delivered` - `Processing` - `Sent` - `Signed` - `TimedOut` - `Voided` For example, if you specify `Changed`, this method returns a list of envelopes that changed status during the `from_date` to `to_date` time period.  
The email address of the sender.  
Ac status | Specifies the Authoritative Copy Status for the envelopes. The possible values are: - `Unknown` - `Original` - `Transferred` - `AuthoritativeCopy` - `AuthoritativeCopyExportPending` - `AuthoritativeCopyExported` - `DepositPending` - `Deposited` - `DepositedEO` - `DepositFailed`  
Envelope ids | The envelope IDs to include in the results. The value of this property can be: - A comma-separated list of envelope IDs - The special value `request_body`. In this case, the method uses the envelope IDs in the request body.  
If set to **true** , removes any results that match one of the provided `transaction_ids`.  
A comma-separated list of envelope status to search for. Possible values are: - `completed` - `created` - `declined` - `deleted` - `delivered` - `processing` - `sent` - `signed` - `template` - `voided`  
From date | The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters `envelope_ids` and/or `transaction_Ids` are provided. *: This parameter must be set to a valid `DateTime`, or `envelope_ids` and/or `transaction_ids` must be specified.  
User name | Limits results to envelopes sent by the account user with this user name. `email` must be given as well, and both `email` and `user_name` must refer to an existing account user.  
Start position | The starting index position for search.  
Transaction ids | The transaction IDs to include in the results. Note that transaction IDs are valid for seven days. The value of this property can be: - A list of comma-separated transaction IDs - The special value `request_body`. In this case, this method uses the transaction IDs in the request body.  
Optional date/time setting that specifies the last date/time or envelope status changes in the result set. The default value is the time that you call the method.  
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 Blob Put Tabs Blob
`<docusign:update-v21-accounts-envelopes-tabs-blob-by-account-id-envelope-id>`
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob 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`  
Config Ref |  ConfigurationProvider | The name of the configuration to use to execute this component  
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
  *
| 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 Put Envelope Transfer Rules
`<docusign:update-v21-accounts-envelopes-transfer-rules-by-account-id>`
This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled.
**Note** : You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
This operation makes an HTTP PUT 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


## Envelope Transfer Rules Put Envelope Transfer Rule
`<docusign:update-v21-accounts-envelopes-transfer-rules-by-account-id-envelope-transfer-rule-id>`
This method changes the status of an envelope transfer rule. You use this method to change whether or not the rule is enabled. You must include the `envelopeTransferRuleId` both as a query parameter, and in the request body.
**Note** : You cannot change any other information about the envelope transfer rule. Only Administrators can update an envelope transfer rule. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId} 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 Transfer Rule Id | The ID of the envelope transfer rule. The system generates this ID when the rule is first created.  
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


## Envelope Workflow Definition Put Envelope Workflow Definition
`<docusign:update-v21-accounts-envelopes-workflow-by-account-id-envelope-id>`
Updates the specified envelope''s workflow definition if it has one. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow 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
  *
| 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


## Favorite Templates Put Favorite Template
`<docusign:update-v21-accounts-favorite-templates-by-account-id>`
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/favorite_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.  
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


## Folders Put Folder By Id
`<docusign:update-v21-accounts-folders-by-account-id-folder-id>`
Moves an envelope from its current folder to the specified folder. You can use this method to delete envelopes by specifying `recyclebin` in the `folderId` parameter. Placing an in-process envelope (envelope status of `sent` or `delivered`) in the recycle bin voids the envelope. You can also use this method to delete templates by specifying a template ID instead of an envelope ID in the `envelopeIds` property and specifying `recyclebin` in the `folderId` parameter.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/folders/{folderId} 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.  
Folder Id | The ID of the folder.  
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


## Brands Put Group Brands
`<docusign:update-v21-accounts-groups-brands-by-account-id-group-id>`
This method adds one or more existing brands to a group based on the `groupId`. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/groups/{groupId}/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.  
Group Id | The ID of the group being accessed.  
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


## Groups Put Groups
`<docusign:update-v21-accounts-groups-by-account-id>`
Updates the group name and modifies, or sets, the permission profile for the group. This operation makes an HTTP PUT 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


## Groups Put Group Users
`<docusign:update-v21-accounts-groups-users-by-account-id-group-id>`
Adds one or more existing DocuSign users to an existing group. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/groups/{groupId}/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.  
Group Id | The ID of the group being accessed.  
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 Put Permission Profiles
`<docusign:update-v21-accounts-permission-profiles-by-account-id-permission-profile-id>`
This method updates an account permission profile. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId} 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.  
Permission Profile Id | The ID of the permission profile. Possible values include: - `2301416` (for the `DocuSign Viewer` profile) - `2301415` (for the `DocuSign Sender` profile) - `2301414` (for the `Account Administrator` profile) In addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`.  
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
  *