Docusign Connector 1.0 Reference
|
Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. |
Anypoint Connector for DocuSign (DocuSign Connector) enables you to access the DocuSign platform and exposes operations provided by the DocuSign eSignature API v2.1. Visit the DocuSign API reference site to learn more.
| The connector does not perform validation on certain fields, such as Envelope Id or Document Id, so you must validate input values for these fields before sending them to the API and invoking the connector’s operations and sources. For example, you can use the Matches regex operation from Validation Module to validate input values for these fields. If you do not validate input values for these fields, there is a possibility of a path traversal attack. |
Configurations
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types to provide to this configuration. |
x |
||
Response Timeout |
Number |
Timeout for request to the remote service. |
1 |
|
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
MINUTES |
|
Streaming Type |
Enumeration, one of:
|
Whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
AUTO |
|
Name |
String |
The identifier of this element used to reference it in other components |
x |
|
Expiration Policy |
Minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
Connection Types
Authorization Connection Provider (Implicit Grant)
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
Timeout for establishing connections to the remote service |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection is closed after the first request is completed. |
true |
|
Max Connections |
Number |
Maximum number of outbound connections to keep open concurrently. |
-1 |
|
Connection Idle Timeout |
Number |
Timeout for how long a connection can remain idle before it is closed. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Idle Timeout field. |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy. |
|||
Stream Response |
Boolean |
Whether or not to stream received responses. |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Base Uri |
String |
Parameter base URI for each instance or tenant. In the DocuSign app, go to Settings > Apps and Keys > My Account Information to find the account base URI and then add |
|
|
Authorization |
String |
Access token obtained by the user from the |
||
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
OAuth Connection Provider (Authorization Code Grant)
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
Timeout for establishing connections to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection is closed after the first request is completed. |
true |
|
Max Connections |
Number |
Mzximum number of outbound connections to keep open concurrently. |
-1 |
|
Connection Idle Timeout |
Number |
Timeout for how long a connection can remain idle before it is closed. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Idle Timeout field. |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy. |
|||
Stream Response |
Boolean |
Whether or not received responses should be streamed |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Base Uri |
String |
Parameter base URI for each instance or tenant. |
|
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
|||
Consumer Key |
String |
OAuth consumer key as registered with the service provider. |
x |
|
Consumer Secret |
String |
OAuth consumer secret as registered with the service provider. |
x |
|
Authorization Url |
String |
Service provider’s authorization endpoint URL. |
|
|
Access Token Url |
String |
Service provider’s access token endpoint URL. |
|
|
Scopes |
String |
OAuth scopes to be requested during the OAuth dance. If not provided, it defaults to the scopes in the annotation. |
signature |
|
Resource Owner Id |
String |
The resource owner ID that each component should use if it is not otherwise referenced. |
||
Before |
String |
Name of the flow to execute immediately before starting the OAuth dance. |
||
After |
String |
Name of a flow to execute immediately after an access token is received. |
||
Listener Config |
String |
References the HTTP configuration used to create the listener that receives the access token callback endpoint. |
x |
|
Callback Path |
String |
Path of the access token callback endpoint. |
x |
|
Authorize Path |
String |
Path of the local HTTP endpoint that triggers the OAuth dance. |
x |
|
External Callback Url |
String |
URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL. |
||
Object Store |
String |
Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store. |
List of Operations
-
Responsive Html Post Template Document Responsive Html Preview
-
Envelope Workflow Definition Delete Envelope Workflow Definition
-
Envelope Workflow Definition Delete Template Workflow Definition
-
Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id
-
Consumer Disclosure Get Consumer Disclosure Envelope Id Recipient Id Lang Code
-
Envelope Workflow Definition Get Envelope Workflow Definition
-
Account Identity Verification Get Account Identity Verification
-
Envelope Purge Configuration Get Envelope Purge Configuration
-
Envelope Workflow Definition Get Template Workflow Definition
-
Envelope Workflow Definition Put Envelope Workflow Definition
-
Envelope Purge Configuration Put Envelope Purge Configuration
-
Envelope Workflow Definition Put Template Workflow Definition
On Envelope Status Change Trigger
<docusign:on-envelope-status-change-trigger>
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID |
x |
|
From Date |
String |
The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Primary Node Only |
Boolean |
Whether this source should only be executed on the primary node when running in a cluster |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message |
|||
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Accounts Post Accounts
<docusign:create-v21-accounts>
Creates new DocuSign accounts. You can use this method to create a single account or up to 100 accounts at a time.
Note: This method is restricted to partner integrations. You must work with DocuSign Professional Services or DocuSign Business Development, who will provide you with the Distributor Code and Distributor Password that you need to include in the request body. You must include the X-DocuSign-Authentication header, for example {{integratorKey}}.
When creating a single account, the body of the request is a [newAccountRequest] object, for example:
{
"newAccountRequest": [
{
"accountName": "Test Account",
"distributorCode": "MY_DIST_CODE",
"distributorPassword": "MY_DIST_PWD",
"initialUser": {
"email": "user@emaildomain.com",
"firstName": "John",
"middleName": "Harry",
"lastName": "Doe",
"suffixName": "",
"userName": "John Doe",
"jobTitle": "Engineer",
"company": "Test Company"
},
"addressInformation": {
"address1": "1234 Main Street",
"address2": "Suite 100",
"city": "Seattle",
"state": "WA",
"postalCode": "98101",
"country": "US",
"phone": "1234567890",
"fax": "1234567891"
},
"planInformation": {
"planId": "37085696-xxxx-xxxx-xxxx-7ea067752959"
},
"referralInformation": {
"includedSeats": "1",
"referralCode": "code",
"referrerName": "name"
}
}
]
}If the request succeeds, it returns a 201 (Created) HTTP response code. The response returns the new account ID, password, and the default user information for each newly created account.
When creating multiple accounts, the body of the request is a newAccountRequests object, which contains one or more [newAccountDefinition] objects. You can create up to 100 new accounts at a time this way. The body for a multi-account creation request looks like this in JSON:
{
"newAccountRequests": [
{ "accountName": "accountone", . . . },
{ "accountName": "accounttwo", . . . }
]
}A multi-account creation request might succeed (report a 201 code) even if some accounts could not be created. In this case, the errorDetails property in the response contains specific information about the failure.
This operation makes an HTTP POST request to the /v2.1/accounts endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
Specifies how the connector streams request content to the remote service:
|
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Payments Post Payment
<docusign:create-v21-accounts-billing-payments-by-account-id>
Posts a payment to a past due invoice. This method can only be used if the paymentAllowed value for a past due invoice is true. This can be determined calling Billing::listInvoicesPastDue. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the nextUri and previousUri properties are not returned.
Privileges required: account administrator
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/billing_payments endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Brands Post Brands
<docusign:create-v21-accounts-brands-by-account-id>
This method creates one or more brand profile files for an account. If the brandId property for a brand profile is already set for the account, an error is returned. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When you upload brand profile files, you must combine them into a single zip file and set the Content-Type to application/zip.
Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/brands endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2CRUD Post Bulk Send List
<docusign:create-v21-accounts-bulk-send-lists-by-account-id>
Creates a bulk send list that you can use to send an envelope to up to 1,000 recipients concurrently. It returns the following errors:
| Error code | Description |
|---|---|
BULK_SEND_MAX_COPIES_EXCEEDED |
A bulk sending list cannot specify more than XXX copies in the mailing list. Call the settings API endpoint to find the maximum number of copies in a batch allowed for your account. In almost all cases, the default limit is 1000. |
BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE |
No two recipientIds can be same within a bulkCopy. Same restriction as a regular envelope applies. Specify unique recipient IDs for each recipient within a bulkCopy (model for envelope in mailing list). |
BULK_SEND_RECIPIENT_ID_REQUIRED |
If no RoleName is present, recipientID is required in mailing list’s bulkCopy. Add a roleName (that coalesces with template/envelope) or a recipientID. |
BULK_SEND_RECIPIENT_NAME_REQUIRED |
Recipient {0} has no name. Specify a name for the recipient. |
BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT |
Recipient {0} is an email recipient with no email address. Specify an email for the email recipient. |
BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT |
Recipient {0} is a fax recipient with no fax number. Specify a fax number for the fax recipient. |
BULK_SEND_FAX_NUMBER_NOT_VALID |
Recipient {0} specifies fax number {1}, which is not valid. Specify a valid fax number for the fax recipient. |
BULK_SEND_EMAIL_ADDRESS_NOT_VALID |
Recipient {0} specifies email address {1}, which is not a valid email address. Specify a valid email address for the recipient. |
BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH |
Recipient {0} specifies SMS auth, but no number was provided. Specify a phone number for the SMS auth recipient. |
BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH |
Recipient {0} specifies phone number {1} for SMS auth, which is not valid. Specify a valid phone number for the SMS auth recipient. |
BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE |
Recipient role names cannot be duplicated; role {duplicateRecipientRole} appears multiple times. Use unique roleNames for recipients. |
BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT |
Recipients cannot have both ID and Role; {0} has both. Specify a roleName or recipientId, but not both for the same recipient. |
BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST |
Cannot use both recipient role and ID in the same list. Specify a roleName or recipientId, but not both in the same list. |
BULK_SEND_INVALID_ID_CHECK_CONFIGURATION |
Recipient {0} specified SMS authentication, but no SMS auth settings were provided. Provide an SMS auth setting (proper ID configuration) if SMS auth is specified. |
BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION |
Recipient {0} has more than one signature provider specified. Or signingProviderName is not specified. Or Signature provider : {0} is either unknown or not an available pen for this account. One or more SBS configuration is missing or invalid. The error details provide specifics. |
BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE |
Tab label {0} is duplicated. Needs to be unique. Use a unique tab label. |
BULK_SEND_TAB_LABEL_REQUIRED |
Tab label is required. Specify a tab label. |
BULK_SEND_TAB_VALUE_REQUIRED |
Tab Label value is required. Specify a value for the tab label. |
BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE |
Custom fields must have distinct names. The field {0} appears more than once in a copy. Use unique names for custom fields. |
BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED |
All custom fields must have names. Specify a name for the custom field. |
BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED |
Custom field {0} has no value. A custom field can have an empty value, but it cannot have a null value. Specify a value for the custom field. |
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/bulk_send_lists endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The ID of the account. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2Send Post Bulk Send Request
<docusign:create-v21-accounts-bulk-send-lists-send-by-account-id-bulk-send-list-id>
Initiates the bulk send process. It generates a bulk send request based on an existing bulk send list and an envelope or template. Consider using the createBulkSendTestRequest method to test your bulk send list for compatibility with the envelope or template that you want to send first. If the envelopes were successfully queued for asynchronous processing, the response contains a batchId that you can use to get the status of the batch. If a failure occurs, the API returns an error message.
Note: Partial success or failure generally does not occur. Only the entire batch is queued for asynchronous processing.
This method returns the following errors:
| Error code | Description |
|---|---|
BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE |
Envelope {0} is not in a sendable state. The envelope is not complete. Make sure it has a sendable status, such as |
BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES |
Cannot send an envelope with a bulk sending list which contains no copies. The list you’re trying to bulk send is empty. Make sure the bulk sending list you’re using contains recipients. |
BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES |
Bulk sending list contains more than {0} copies. The list you’re trying to bulk send will cause your account to exceed the 1,000-copy limit imposed for all accounts. Try sending two or more separate lists. |
BULK_SEND_ENVELOPE_CANNOT_BE_NULL |
Cannot send a bulk list without an envelope. Specify the envelope ID or template ID for the envelope you want to bulk send. |
BULK_SEND_BLOB_STORE_ERROR |
Could not save copy of bulk sending list. An error writing to the database occurred. Try again. If the error persists, contact DocuSign Support. |
BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES |
Cannot send this bulk sending list because doing so would exceed the maximum of {maxCopies} in-flight envelopes. This account currently has {unprocessedEnvelopes} envelopes waiting to be processed. Please try again later." .Try again later, or contact DocuSign Support to request a higher tier. |
BULK_SEND_ENVELOPE_NOT_FOUND |
Envelope {envelopeOrTemplateId} does not exist or you do not have permission to access it. The envelopeId or templateId specified could not be found. Specify a valid value. |
BULK_SEND_LIST_NOT_FOUND |
Bulk Sending list {listId} does not exist or you do not have permission to access it. The mailingListId specified could not be found. Specify a valid value. |
BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS |
Bulk sending copy contains recipients, but the specified envelope does not. The recipients on the envelope and the bulk send list do not match. Make sure the envelope and list are compatible for sending. |
BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE |
Recipient {0} does not exist in the envelope. Add the missing recipient to the envelope. |
BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH |
Recipient ID {envelopeMember.ID} does not match. Make sure the recipient information in the list and the envelope match up. |
BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT |
Recipient {0} is a bulk recipient. This is not supported. No legacy 'bulk recipient' allowed. In v2.1 of the eSignature API, you must use a bulk send list instead of a bulk recipient. See the API documentation for details. |
BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH |
Recipient Role {envelopeMember.RoleName} does not match. Make sure the recipient information in the list and the envelope is compatible. |
BULK_SEND_DUPLICATE_RECIPIENT_DETECTED |
Duplicate recipients ({0}) not allowed, unless recipients have unique routing order specified on envelope. |
BULK_SEND_ENVELOPE_HAS_NO_TABS |
Bulk sending copy contains tabs, but the specified envelope does not. List and envelope tabs cannot be coalesced. Make sure they are compatible for sending. |
BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE |
Tab with label {0} does not exist in envelope. Add the tab label to the envelope, remove the label from the list, or make sure you’re specifying the correct list and envelope. |
BULK_SEND_TAB_DOES_NOT_MATCH |
Tab {0} does not match {0} in envelope. A tab exists on the list that does not match or is missing on the envelope. Make sure the tabs on the list and the envelope match. |
BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS |
Bulk sending copy contains custom fields, but the specified envelope does not. There are custom fields on the list that the envelope does not have. Make sure that any custom fields on the list and the envelope match. |
BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE |
Custom field {0} does not exist in the envelope. Either add the custom field on the list to the envelope, remove the custom field from the list, or make sure you’re specifying the correct list and envelope. |
BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH |
Custom field names must match. {0} and {1} do not match. The custom field names on the list and the envelope do not match. Use identical names for both. |
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Bulk Send List Id |
String |
The GUID of the bulk send list. This property is created after you post a new bulk send list. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Bulk Send V2Test Post Bulk Send Test Request
<docusign:create-v21-accounts-bulk-send-lists-test-by-account-id-bulk-send-list-id>
This method tests a bulk send list for compatibility with the envelope or template that you want to send. For example, a template that has three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to test compatibility first. A successful test result returns true for the canBeSent property. An unsuccessful test returns a JSON response that contains information about the errors that occurred. If the test is successful, you can then send the envelope or template by using the BulkSendRequest method.
Envelope Compatibility Checks
This section describes the envelope compatibility checks that the system performs.
Top-Level Issues
-
Envelopes must be in a sendable state.
-
The bulk send list must contain at least one copy (instance of an envelope), and no more than the maximum number of copies allowed for the account.
-
The envelope must not be null and must be visible to the current user.
-
The account cannot have more queued envelopes than the maximum number configured for the account.
-
The bulk send list must exist.
-
-
Recipients
-
The envelope must have recipients.
-
If you are using an envelope, all of the recipients defined in the bulk send list must have corresponding recipient IDs in the envelope definition. If you are using a template, you must either match the recipient IDs or role IDs.
-
The envelope cannot contain a bulk recipient (an artifact of the legacy version of DocuSign’s bulk send functionality).
-
-
Recipient Tabs
-
Every
recipient ID, tab labelpair in the bulk send list must correspond to a tab in the envelope.
-
-
Custom Fields
-
Each envelope-level custom field in the bulk send list must correspond to the name of a
customFieldin the envelope definition. You do not have to match the recipient-level custom fields.
-
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Bulk Send List Id |
String |
The GUID of the bulk send list. This property is created after you post a new bulk send list. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Chunked Uploads Post Chunked Uploads
<docusign:create-v21-accounts-chunked-uploads-by-account-id>
This method initiates a new chunked upload with the first part of the content. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/chunked_uploads endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Connect Post Connect Configuration
<docusign:create-v21-accounts-connect-by-account-id>
Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. These updates might or might not include the document itself.
Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/connect endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Contacts Post Contacts
<docusign:create-v21-accounts-contacts-by-account-id>
This method imports multiple new contacts into a contact list from a CSV, JSON, or XML file. To use this method, you must provide a request body in one of the supported formats and include a content-type header with the appropriate value. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/contacts endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Custom Fields Post Account Custom Fields
<docusign:create-v21-accounts-custom-fields-by-account-id>
This method creates a custom field and makes it available for all new envelopes associated with an account. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/custom_fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Apply to templates |
String |
(Optional) When set to true, the new custom field is applied to all of the templates on the account. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelopes Post Envelopes
<docusign:create-v21-accounts-envelopes-by-account-id>
Creates and sends an envelope or creates a draft envelope. Envelopes are fundamental resources in the DocuSign platform. With this method you can:
-
Create and send an envelope with documents, recipients, and tabs.
-
Create and send an envelope from a template.
-
Create and send an envelope from a combination of documents and templates.
-
Create a draft envelope.
When you use this method to create and send an envelope in a single request, the following parameters in the request body are required:
| Parameter | Description |
|---|---|
|
Set to |
|
The subject of the email used to send the envelope. |
|
The [documents][] to be signed. |
|
The email addresses of the envelope recipients. |
Note: If the envelope has a workflow definition and the workflowStatus is paused, the envelope will not be sent immediately, even if the envelope’s status is sent. There are many ways to use envelopes. You can create and send an envelope with a single API request, or you can use several API requests to create, populate, and send envelopes.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Cdse mode |
String |
Reserved for DocuSign. |
||
Change routing order |
String |
When true, users can define the routing order of recipients while sending documents for signature. |
||
Completed documents only |
String |
Reserved for DocuSign. |
||
Merge roles on draft |
String |
When set to true, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the |
||
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Custom Fields Post Custom Fields
<docusign:create-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>
Updates the envelope custom fields for draft and in-process envelopes. You may assign up to three envelope custom fields to an envelope. This limit does not include account (document) custom fields. Each custom field used in an envelope must have a unique name. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Document Fields Post Document Fields
<docusign:create-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>
Creates custom document fields in an existing envelope document. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Post Document Responsive Html Preview
<docusign:create-v21-accounts-envelopes-documents-responsive-html-preview-by-account-id-envelope-id-document-id>
Creates a preview of the responsive HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Post Document Tabs
<docusign:create-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Post Document Templates
<docusign:create-v21-accounts-envelopes-documents-templates-by-account-id-envelope-id-document-id>
Adds templates to a document in the specified envelope. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Preserve template recipient |
String |
Preserve template recipient |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Email Settings Post Email Settings
<docusign:create-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>
Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made.
The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copy or Certified Delivery recipient type.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Lock Post Envelope Lock
<docusign:create-v21-accounts-envelopes-lock-by-account-id-envelope-id>
This method locks the specified envelope and sets the time until the lock expires to prevent other users or recipients from changing the envelope. The response to this request returns a lockToken parameter. You must use the lockToken to update or delete an existing lock. You must also include the lockToken in the header for every PUT call that you make on the envelope while it is locked. If you do not include the lockToken, the system returns the following error:
{ "errorCode": "EDIT_LOCK_NOT_LOCK_OWNER", "message": "The user is not the owner of the lock. The template is locked by another user or in another application" }
Note: Users must have envelope locking capability enabled to use this function (userSetting canLockEnvelopes must be set to true for the user).
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Post Recipients
<docusign:create-v21-accounts-envelopes-recipients-by-account-id-envelope-id>
Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient’s routing order is before or the same as the envelope’s next recipient, an email is only sent if the optional resend_envelope query string is set to true.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Resend envelope |
String |
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. |
||
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Post Recipient Proof File Resource Token
<docusign:create-v21-accounts-envelopes-recipients-identity-proof-token-by-account-id-envelope-id-recipient-id>
Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The account ID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
The |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Post Recipient Tabs
<docusign:create-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>
Adds one or more tabs for a recipient. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Post Responsive Html Preview
<docusign:create-v21-accounts-envelopes-responsive-html-preview-by-account-id-envelope-id>
Creates a preview of the responsive HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Post Envelope Templates
<docusign:create-v21-accounts-envelopes-templates-by-account-id-envelope-id>
Adds templates to the specified envelope. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Preserve template recipient |
String |
Preserve template recipient |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Envelope Transfer Rules Post Envelope Transfer Rules
<docusign:create-v21-accounts-envelopes-transfer-rules-by-account-id>
Creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties:
-
eventType -
fromGroups -
toUser -
toFolder -
carbonCopyOriginalOwner -
enabled
Note: Only Administrators can create envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/transfer_rules endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Correct View
<docusign:create-v21-accounts-envelopes-views-correct-by-account-id-envelope-id>
Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.
Note: You can revoke this URL by making the DELETE call to the same URL with no request body. Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access. If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:
-
Configure each sender to have their own individual user account to use this API method.
-
Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Edit View
<docusign:create-v21-accounts-envelopes-views-edit-by-account-id-envelope-id>
Returns a URL that enables you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application.
Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.
You can revoke this URL by making the DELETE call to the same URL with no request body.
Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.
If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:
-
Configure each sender to have their own individual user account to use this API method.
-
Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/edit endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Recipient View
<docusign:create-v21-accounts-envelopes-views-recipient-by-account-id-envelope-id>
Returns a URL that enables you to embed the recipient view of the DocuSign UI in your applications. If the recipient is a signer, then the view will provide the signing ceremony.
Note: Please redirect the client to the URL. iFrames should not be used, especially if the recipient is using a mobile or tablet. This method is only used with envelopes in the sent status. Your application is responsible for authenticating the identity of the recipient or signer when you use this method. Use the parameters assertionId, authenticationInstant, authenticationMethod, clientUserId, and securityDomain to record information on how the recipient was authenticated. At a minimum, authenticationMethod and clientUserId are required. The information that you provide is included in the envelope’s certificate of completion.
Redirects
After the signer completes or ends the signing ceremony, DocuSign will redirect the user’s browser back to your app via the returnUrl that you supply. (The user is redirected through a different subdomain, depending on the region of the account sending the envelope. Verify your domain allowlist.)
The event status parameter
DocuSign appends an event query parameter to the URL with the outcome of the signing ceremony. Your app can use this event parameter to determine the next step for the envelope. Do not fetch the envelope status by using Envelopes::get or a similar method because doing so could break the DocuSign rule against polling.
Note: Because a user can cancel redirection, close their browser after signing, or spoof the landing URL. Hitting the ReturnUrl should not be the single source of truth for envelope status for your integration.
The URL is time-limited
The URL returned by this method is valid for one use, and you must use or display it within a couple of minutes after it is generated. AFter the recipient is redirected to the recipient view, they must interact with the DocuSign system periodically or their session will time out. Because the URL is time-limited, it should not be stored or sent through email. After you receive it, immediately redirect the user’s browser to the URL. If you want to invite someone to an embedded signing session via email, the email invitation’s URL must be to your application. When invoked, your app should request a recipientView URL from DocuSign and then redirect the signer to that URL.
Maintaining State
After the recipient completes the recipient view (or signing ceremony), they are redirected to your application. Your application can recover state information about the transaction by storing information in a cookie, or by including query parameters in the returnUrl field, for example https://myapp.eg.com/docusign_return?myState=12345. When the user is redirected to your app, the event query parameter will be appended. In this example, prevent spoofing by not using a guessable value as the state value.
Note: You can revoke the URL by making the DELETE call to the same URL with no request body.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Recipient Preview
<docusign:create-v21-accounts-envelopes-views-recipient-preview-by-account-id-envelope-id>
This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Sender View
<docusign:create-v21-accounts-envelopes-views-sender-by-account-id-envelope-id>
Returns a URL that enables you to embed the sender view of the DocuSign UI in your applications. The returned URL can only be redirected to immediately after it is generated. It can only be used once. Therefore, request the URL immediately before you redirect your user to it.
For the best user experience, don’t use an iFrame. For iOS devices DocuSign recommends using a WebView. Multiple solutions are available for maintaining your client state. After the user has completed the sending view, the browser is redirected to the returnUrl supplied. By default, if the envelope already contains one or more documents, DocuSign will initially show the document tagging view when you redirect to the URL.
To start with the envelope’s recipients and documents view instead, examine the URL in the method’s response. Then change the query parameter from send=1 to send=0 to start with the recipients/documents view.
Note: You can revoke the URL by making the DELETE call to the same URL with no request body.
Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.
If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:
-
Configure each sender to have their own individual user account to use this API method.
-
Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Envelope Recipient Shared View
<docusign:create-v21-accounts-envelopes-views-shared-by-account-id-envelope-id>
Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. The view that a user sees of an envelope that a recipient on the same account has shared with them.
Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.
You can revoke this URL by making the DELETE call to the same URL with no request body.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Groups Post Groups
<docusign:create-v21-accounts-groups-by-account-id>
Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the userSettings property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/groups endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Permission Profiles Post Permission Profiles
<docusign:create-v21-accounts-permission-profiles-by-account-id>
This method creates a new permission profile for an account. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/permission_profiles endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
include |
String |
A comma-separated list of additional properties to return in the response. The only valid value for this request is |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Post Power Form
<docusign:create-v21-accounts-powerforms-by-account-id>
This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, based on the templateId in the request body. PowerForms that you create from a template are referred to as web PowerForms.
The RADmin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a PDF PowerForm). However, PDF PowerForms are deprecated and are not supported in the API.
A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm initiator.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.
Signing modes
You can use one of the following signing modes for a PowerForm: email This mode verifies the recipient’s identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks Begin Signing to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document.
Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the activateonly flag to the PowerForm URL and set it to true by passing in the value 1. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: activateonly=1 direct. This mode does not require any verification.
After a recipient enters their email address on the landing page and clicks Begin Signing, a new browser tab opens and the recipient can immediately begin the signing process. Because the direct signing mode does not verify the recipient’s identity by using email authentication, DocuSign strongly recommends that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient’s identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). Note: In the account settings, enablePowerFormDirect must be true to use direct as the signingMode.
Redirect URLs
You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](https://support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed).
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/powerforms endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Post Report In Product Create
<docusign:create-v21-accounts-reports-by-account-id>
Reports In Product Post Report In Product Create This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/reports endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
BCCEmail Archive Post BCCEmail Archive
<docusign:create-v21-accounts-settings-bcc-email-archives-by-account-id>
This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates). The only property that you must set in the request body is the BCC email address that you want to use.
Note: An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/settings/bcc_email_archives endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Post Account Signatures
<docusign:create-v21-accounts-signatures-by-account-id>
Account Signatures Post Account Signatures This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/signatures endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Decode only |
String |
Decode only |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Post Signing Groups
<docusign:create-v21-accounts-signing-groups-by-account-id>
Creates one or more signing groups. Multiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. An account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members. Signing groups can be used by any account user. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/signing_groups endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Post Tab Definitions
<docusign:create-v21-accounts-tab-definitions-by-account-id>
Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/tab_definitions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Post Templates
<docusign:create-v21-accounts-templates-by-account-id>
Creates one or more template definitions, using a multipart request for each template. Templates help streamline the sending process when you frequently send the same or similar documents, or send different documents to the same group of people. When you create a template, you define placeholder roles. Rather than specifying a person, you specify a role that regularly participates in a transaction that uses the template. Then, when you create or send an envelope based on the template, you assign actual recipients to the template roles. The recipients automatically inherit all of the workflow that is defined for that role in the template, such as the tabs and routing information. For code examples and more information, see REST API Templates.
Template Email Subject Merge Fields
Placeholder roles have associated merge fields that personalize the email notification that DocuSign sends. For example, the template automatically personalizes the email message by adding placeholders for the recipient’s name and email address within the email subject line, based on the recipient’s role. When the sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to find out who the recipient is.
If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where you expect the recipient name or email to be long, you should consider placing the merge field at the start of the email subject.
To insert a recipient’s name into the subject line, add the following text in the emailSubject property when you create the template:
[[<roleName>_UserName]]
Example:
"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",
To add a recipient’s email address in the subject line, add the following text in the emailSubject property when you create the template or send an envelope from the template:
[[<roleName>_Email]]
Example:
"emailSubject":"[[Signer 1_Email]], Please sign this NDA",
In these examples, the role name specified in the template is “Signer 1”. When the envelope is sent, the placeholder will be dynamically substituted with the recipient’s name or email.
Creating multiple templates
To create multiple templates, you provide a zip file of JSON files. You can also use the Templates::ListTemplates method with the is_download query parameter to download a zip file containing your existing templates and use that as a guide. The API supports both .zip and .gzip file formats as input.
You also need to set the following headers:
-
Content-Length -
Content-Type -
Content-Disposition
Example:
Content-Length: 71068 Content-Type: application/zip Content-Disposition: file; filename="DocuSignTemplates_Nov_25_2019_20_40_21.zip"; fileExtension=.zip
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
(Required) The external account number (int) or account ID GUID. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Custom Fields Post Template Custom Fields
<docusign:create-v21-accounts-templates-custom-fields-by-account-id-template-id>
Creates custom document fields in an existing template document. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Document Fields Post Template Document Fields
<docusign:create-v21-accounts-templates-documents-fields-by-account-id-template-id-document-id>
Creates custom document fields in an existing template document. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Post Template Document Responsive Html Preview
<docusign:create-v21-accounts-templates-documents-responsive-html-preview-by-account-id-template-id-document-id>
Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Tabs Post Template Document Tabs
<docusign:create-v21-accounts-templates-documents-tabs-by-account-id-template-id-document-id>
This method creates Template Document Tabs. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Lock Post Template Lock
<docusign:create-v21-accounts-templates-lock-by-account-id-template-id>
Locks the specified template and sets the time until the lock expires to prevent other users or recipients from changing the template. The response to this request returns a lockToken parameter. You must use the lockToken to update or delete an existing lock. You must also include the lockToken in the header for every PUT call that you make on the template while the template is locked. If you do not include the lockToken, the system returns the following error:
{ "errorCode": "EDIT_LOCK_NOT_LOCK_OWNER", "message": "The user is not the owner of the lock. The template is locked by another user or in another application" }
Users must have envelope locking capability enabled to use this function (the userSetting property canLockEnvelopes must be set to true for the user).
|
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/lock endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Post Template Recipients
<docusign:create-v21-accounts-templates-recipients-by-account-id-template-id>
Adds one or more recipients to a template. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Resend envelope |
String |
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. |
||
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Recipients Post Template Recipient Tabs
<docusign:create-v21-accounts-templates-recipients-tabs-by-account-id-template-id-recipient-id>
Adds one or more tabs for a recipient. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Post Template Responsive Html Preview
<docusign:create-v21-accounts-templates-responsive-html-preview-by-account-id-template-id>
Creates a preview of the [responsive](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/api-overview), HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Template Edit View
<docusign:create-v21-accounts-templates-views-edit-by-account-id-template-id>
This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/views/edit endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Template Recipient Preview
<docusign:create-v21-accounts-templates-views-recipient-preview-by-account-id-template-id>
This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Users Post Users
<docusign:create-v21-accounts-users-by-account-id>
Adds new users to an account. The body of this request is an array of newUsers objects. For each new user, you must provide at least the userName and email properties. The userSettings property specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email is in French because the locale is set to fr.
POST /restapi/v2.1/accounts/{accountId}/users
Content-Type: application/json
{
"newUsers": [{
"userName": "Claire Horace",
"email": "claire@example.com"
}, {
"userName": "Tal Mason",
"email": "talmason@example.com",
"company": "TeleSel",
"userSettings": {
"locale": "fr",
"canSendEnvelope": true
}
}]
}A successful response is a newUsers array with information about the newly created users. If there was a problem in creating a user, that user entry will contain an errorDetails property that describes what went wrong.
{
"newUsers": [{
"userId": "18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade",
"uri": "/users/18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade",
"email": "claire@example.com",
"userName": "Claire Horace",
"createdDateTime": "0001-01-01T08:00:00.0000000Z",
"errorDetails": {
"errorCode": "USER_ALREADY_EXISTS_IN_ACCOUNT",
"message": "Username and email combination already exists for this account."
}
}, {
"userId": "be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33",
"uri": "/users/be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33",
"email": "talmason@example.com",
"userName": "Tal Mason",
"userStatus": "ActivationSent",
"createdDateTime": "2020-05-26T23:25:30.7330000Z"
}]
}This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Cloud Storage Post Cloud Storage
<docusign:create-v21-accounts-users-cloud-storage-by-account-id-user-id>
Configures the redirect URL information for one or more cloud storage providers for the specified user. The redirect URL is added to the authentication URL to complete the return route. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/users/{userId}/cloud_storage endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Post User Signatures
<docusign:create-v21-accounts-users-signatures-by-account-id-user-id>
Adds a user signature image and/or user initials image to the specified user. The userId property specified in the endpoint must match the authenticated user’s userId and the user must be a member of the account. The rules and processes associated with this are:
-
If
Content-Typeis set toapplication/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used. -
If
Content-Typeis set tomultipart/form-data, then the request must contain a first part with the user signature information, followed by parts that contain the images.
For each Image part, the Content-Disposition header has a "filename" value that is used to map to the signatureName and/or signatureInitials properties in the JSON to the image, for example`Content-Disposition: file; filename="Ron Test20121127083900"`.
If no matching image (by filename value) is found, then the image is not set. One, both, or neither of the signature and initials images can be set with this call.
The Content-Transfer-Encoding: base64 header, set in the header for the part containing the image, can be set to indicate that the images are formatted as base64 instead of as binary.
If successful, 200-OK is returned, and a JSON structure containing the signature information is provided, note that the signatureId can change with each API POST, PUT, or DELETE since the changes to the signature structure cause the current signature to be closed, and a new signature record to be created.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/users/{userId}/signatures endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Post Account Console View
<docusign:create-v21-accounts-views-console-by-account-id>
Returns a URL that enables you to embed the authentication view of the DocuSign UI in your applications. Note: You can revoke this URL by making the DELETE call to the same URL with no request body.
Information Security notice: This method provides full administrator access to the account.
This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/views/console endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Post Workspace
<docusign:create-v21-accounts-workspaces-by-account-id>
This method creates a new workspace. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/workspaces endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Post Workspace Files
<docusign:create-v21-accounts-workspaces-folders-files-by-account-id-workspace-id-folder-id>
This method adds a file to a workspace. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Folder Id |
String |
The ID of the folder. |
x |
|
Workspace Id |
String |
The ID of the workspace. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Post Notary
<docusign:create-v21-current-user-notary>
Registers the current user as a notary. This operation makes an HTTP POST request to the /v2.1/current_user/notary endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Post Notary Jurisdictions
<docusign:create-v21-current-user-notary-jurisdictions>
Creates a jurisdiction object. This operation makes an HTTP POST request to the /v2.1/current_user/notary/jurisdictions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Brands
<docusign:delete-v21-accounts-brands-by-account-id>
This method deletes one or more brand profiles from an account, based on the brand ids that you include in the brandsRequest.
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 DELETE request to the /v2.1/accounts/{accountId}/brands endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Brand
<docusign:delete-v21-accounts-brands-by-account-id-brand-id>
This method deletes a brand from an account.
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 DELETE request to the /v2.1/accounts/{accountId}/brands/{brandId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Brand Id |
String |
The ID of the brand. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Brand Logo
<docusign:delete-v21-accounts-brands-logos-by-account-id-brand-id-logo-type>
This method deletes a single logo from 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 DELETE request to the /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Brand Id |
String |
The ID of the brand. |
x |
|
Logo Type |
String |
The type of logo. Valid values are: - |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Bulk Send List
<docusign:delete-v21-accounts-bulk-send-lists-by-account-id-bulk-send-list-id>
This method deletes a bulk send list. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Bulk Send List Id |
String |
The GUID of the bulk send list. This property is created after you post a new bulk send list. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Accounts Delete Account
<docusign:delete-v21-accounts-by-account-id>
This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Captive Recipients Delete Captive Recipients Part
<docusign:delete-v21-accounts-captive-recipients-by-account-id-recipient-part>
This method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/captive_recipients/{recipientPart} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Part |
String |
Signature is the only supported value. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Chunked Upload
<docusign:delete-v21-accounts-chunked-uploads-by-account-id-chunked-upload-id>
Deletes a chunked upload that has been committed but not yet consumed. This method cannot be used to delete the following types of chunked uploads, which the system deletes automatically:
-
Chunked uploads that have been consumed by use in another API call.
-
Expired chunked uploads.
Note: If you are aware of a chunked upload that can be discarded, the best practice is to explicitly delete it. If you wait for the system to automatically delete it after it expires, the chunked upload continues to count against your quota.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Chunked Upload Id |
String |
The ID of the chunked upload. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Connect Config
<docusign:delete-v21-accounts-connect-by-account-id-connect-id>
Deletes the specified DocuSign Connect configuration.
Note: Connect must be enabled for your account to use this function.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/connect/{connectId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Connect Id |
String |
The ID of the custom Connect configuration being accessed. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Failures Delete Connect Failure Log
<docusign:delete-v21-accounts-connect-failures-by-account-id-failure-id>
Deletes the Connect failure log information for the specified entry. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/connect/failures/{failureId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Failure Id |
String |
The ID of the Connect post failure. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Log Delete Connect Logs
<docusign:delete-v21-accounts-connect-logs-by-account-id>
Deletes a list of Connect log entries for your account. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/connect/logs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Log Delete Connect Log
<docusign:delete-v21-accounts-connect-logs-by-account-id-log-id>
Deletes a specified entry from the Connect Log. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/connect/logs/{logId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Log Id |
String |
The ID of the Connect log entry. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Contacts
<docusign:delete-v21-accounts-contacts-by-account-id>
This method deletes multiple contacts associated with an account. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/contacts endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Contact With Id
<docusign:delete-v21-accounts-contacts-by-account-id-contact-id>
This method deletes a contact associated with an account. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/contacts/{contactId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Contact Id |
String |
The ID of a contact person in the account''s address book. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Account Custom Fields
<docusign:delete-v21-accounts-custom-fields-by-account-id-custom-field-id>
This method deletes an existing account custom field. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/custom_fields/{customFieldId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Custom Field Id |
String |
The ID of the custom field. |
x |
|
Apply to templates |
String |
Apply to templates |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Attachments
<docusign:delete-v21-accounts-envelopes-attachments-by-account-id-envelope-id>
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Custom Fields
<docusign:delete-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>
Deletes envelope custom fields for draft and in-process envelopes. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Documents
<docusign:delete-v21-accounts-envelopes-documents-by-account-id-envelope-id>
Deletes one or more documents from an existing envelope that has not yet been completed. To delete a document, use only the relevant parts of the envelopeDefinition. For example, this request body specifies that you want to delete the document whose documentId is "1":
{ "documents": [ { "documentId": "1" } ] }
The envelope status must be one of:
-
created -
sent -
delivered
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Document Fields
<docusign:delete-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>
Deletes custom document fields from an existing envelope document. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Page
<docusign:delete-v21-accounts-envelopes-documents-pages-by-account-id-envelope-id-document-id-page-number>
Deletes a page from a document in an envelope based on the page number. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Page Number |
String |
The page number being accessed. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Document Tabs
<docusign:delete-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Delete Document Templates
<docusign:delete-v21-accounts-envelopes-documents-templates-by-account-id-envelope-id-document-id-template-id>
Deletes the specified template from a document in an existing envelope. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates/{templateId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Email Settings
<docusign:delete-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>
Deletes all existing email override settings for the envelope. If you want to delete an individual email override setting, use the PUT and set the value to an empty string. Note that deleting email settings will only affect email communications that occur after the deletion and the normal account email settings are used for future email communications.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Envelope Lock
<docusign:delete-v21-accounts-envelopes-lock-by-account-id-envelope-id>
Deletes the lock from 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, for example X-DocuSign-Edit:{{lockToken}}.
Important: You must use the query parameter save_changes to indicate whether you want to commit the user’s changes when deleting the lock. When set to true, the system commits the changes that the user made while the lock was active. When set to false, the user’s changes are discarded. This query parameter does not currently appear in the list of query parameters on this page. However, it is crucial that you include it to ensure that the user’s changes are saved or discarded as appropriate.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Recipients
<docusign:delete-v21-accounts-envelopes-recipients-by-account-id-envelope-id>
Deletes one or more recipients from a draft or sent envelope. List the recipients that you want to delete in the body of the request. This method uses the recipientId as the key for deleting recipients. If the envelope is In Process, meaning that it has been sent and has not been completed or voided, recipients that have completed their actions cannot be deleted. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Recipient
<docusign:delete-v21-accounts-envelopes-recipients-by-account-id-envelope-id-recipient-id>
Deletes a recipient from a draft or sent envelope. If the envelope is "In Process" (has been sent and is not completed or voided), recipients that have completed their actions cannot be deleted. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Recipient Tabs
<docusign:delete-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>
Deletes one or more tabs associated with a recipient in a draft envelope. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Envelope Transfer Rules
<docusign:delete-v21-accounts-envelopes-transfer-rules-by-account-id-envelope-transfer-rule-id>
This method deletes an envelope transfer rule.
Note: Only Administrators can delete envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/transfer_rules/{envelopeTransferRuleId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Transfer Rule Id |
String |
The ID of the envelope transfer rule. The system generates this ID when the rule is first created. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Views Delete Envelope Correct View
<docusign:delete-v21-accounts-envelopes-views-correct-by-account-id-envelope-id>
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Envelope Workflow Definition
<docusign:delete-v21-accounts-envelopes-workflow-by-account-id-envelope-id>
Deletes the specified envelope’s workflow definition if it has one. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Un Favorite Template
<docusign:delete-v21-accounts-favorite-templates-by-account-id>
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/favorite_templates endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Group Brands
<docusign:delete-v21-accounts-groups-brands-by-account-id-group-id>
This method deletes one or more brands from a group. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/groups/{groupId}/brands endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Group Id |
String |
The ID of the group. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Groups
<docusign:delete-v21-accounts-groups-by-account-id>
Deletes an existing user group. When you delete a group, you include only the groupId in the request body.
Example: { "groups": [ { "groupId": "12345" } }
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/groups endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Group Users
<docusign:delete-v21-accounts-groups-users-by-account-id-group-id>
Deletes one or more users from a group. This request takes a userInfoList that contains the users that you want to delete. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/groups/{groupId}/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Group Id |
String |
The ID of the group being accessed. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Permission Profiles
<docusign:delete-v21-accounts-permission-profiles-by-account-id-permission-profile-id>
This method deletes a permission profile from an account. To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the move_users_to query parameter. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Permission Profile Id |
String |
The ID of the permission profile. Possible values include: - |
x |
|
Move users to |
String |
Move users to |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Delete Power Forms List
<docusign:delete-v21-accounts-powerforms-by-account-id>
This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the powerFormId. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/powerforms endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Delete Power Form
<docusign:delete-v21-accounts-powerforms-by-account-id-power-form-id>
This method deletes a PowerForm. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/powerforms/{powerFormId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Power Form Id |
String |
The ID of the PowerForm. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Delete Report In Product
<docusign:delete-v21-accounts-reports-by-account-id-id>
Reports In Product Delete Report In Product This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/reports/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
ID |
String |
A unique ID for the Salesforce object. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
BCCEmail Archive Delete BCCEmail Archive
<docusign:delete-v21-accounts-settings-bcc-email-archives-by-account-id-bcc-email-archive-id>
This method deletes a BCC email archive configuration from an account. When you use this method, the status of the BCC email archive configuration switches to closed and the BCC email address is no longer used to archive DocuSign-generated email messages.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Bcc Email Archive Id |
String |
The ID of the BCC email archive configuration. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
ENote Configuration Delete ENote Configuration
<docusign:delete-v21-accounts-settings-enote-configuration-by-account-id>
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/settings/enote_configuration endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Delete Account Signature
<docusign:delete-v21-accounts-signatures-by-account-id-signature-id>
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/signatures/{signatureId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Delete Account Signature Image
<docusign:delete-v21-accounts-signatures-by-account-id-signature-id-image-type>
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Image Type |
String |
Specificies the type of image. Valid values are: - |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Delete Signing Groups
<docusign:delete-v21-accounts-signing-groups-by-account-id>
Deletes one or more signing groups in the specified account. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/signing_groups endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Delete Signing Group Users
<docusign:delete-v21-accounts-signing-groups-users-by-account-id-signing-group-id>
Deletes one or more members from the specified signing group. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signing Group Id |
String |
Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Tab Delete Custom Tab
<docusign:delete-v21-accounts-tab-definitions-by-account-id-custom-tab-id>
Deletes the custom from the specified account. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/tab_definitions/{customTabId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Custom Tab Id |
String |
The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Delete Template Part
<docusign:delete-v21-accounts-templates-by-account-id-template-id-template-part>
Removes a member group''s sharing permissions for a specified template. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Template Part |
String |
Currently, the only defined part is groups. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Custom Fields
<docusign:delete-v21-accounts-templates-custom-fields-by-account-id-template-id>
Deletes envelope custom fields in a template. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Documents
<docusign:delete-v21-accounts-templates-documents-by-account-id-template-id>
This method deletes one or more documents from an existing template. To delete a document, use only the relevant parts of the envelopeDefinition. For example, this request body specifies that you want to delete the document whose documentId is "1": { "documents": [ { "documentId": "1" } ] }
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Document Fields
<docusign:delete-v21-accounts-templates-documents-fields-by-account-id-template-id-document-id>
Deletes custom document fields from an existing template document. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Page
<docusign:delete-v21-accounts-templates-documents-pages-by-account-id-template-id-document-id-page-number>
Deletes a page from a document in a template based on the page number. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Page Number |
String |
The page number being accessed. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Document Tabs
<docusign:delete-v21-accounts-templates-documents-tabs-by-account-id-template-id-document-id>
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Lock
<docusign:delete-v21-accounts-templates-lock-by-account-id-template-id>
This method deletes a lock from a template. You must 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, for example X-DocuSign-Edit:{{lockToken}}
Important: You must use the query parameter save_changes to indicate whether you want to commit the user’s changes when deleting the lock. When set to true, the system commits the changes that the user made while the lock was active. When set to false, the user’s changes are discarded. This query parameter does not currently appear in the list of query parameters on this page due to a technical issue. However, it is crucial that you include it to ensure that the user’s changes are saved or discarded as appropriate.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/lock endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Bulk Recipients File
<docusign:delete-v21-accounts-templates-recipients-bulk-recipients-by-account-id-template-id-recipient-id>
Deletes the bulk recipient list on a template. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Recipients
<docusign:delete-v21-accounts-templates-recipients-by-account-id-template-id>
Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the recipientId being used as the key for deleting recipients.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Recipient
<docusign:delete-v21-accounts-templates-recipients-by-account-id-template-id-recipient-id>
Deletes the specified recipient file from the specified template. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Recipient Tabs
<docusign:delete-v21-accounts-templates-recipients-tabs-by-account-id-template-id-recipient-id>
Deletes one or more tabs associated with a recipient in a template. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Template Workflow Definition
<docusign:delete-v21-accounts-templates-workflow-by-account-id-template-id>
Deletes the specified template''s workflow definition if it has one. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/templates/{templateId}/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Users Delete Users
<docusign:delete-v21-accounts-users-by-account-id>
Closes one or more user records in the account. Users are never deleted from an account, but closing a user prevents them from using account functions. The response specifies whether the API execution succeeded (200 - OK) or failed (400 - Error). The response contains a user structure similar to the request and includes the user changes.
If an error occurred during the DELETE operation for any of the users, the response for that user contains an errorDetails property with errorCode and message properties.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
delete |
String |
ID of the user to delete. This parameter takes a comma-separated list of values in the format: |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Cloud Storage Delete Cloud Storage Providers
<docusign:delete-v21-accounts-users-cloud-storage-by-account-id-user-id>
Deletes the user authentication information for one or more cloud storage providers. The next time the user tries to access the cloud storage provider, they must pass normal authentication. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/users/{userId}/cloud_storage endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Cloud Storage Delete Cloud Storage
<docusign:delete-v21-accounts-users-cloud-storage-by-account-id-user-id-service-id>
Deletes the user authentication information for the specified cloud storage provider. The next time the user tries to access the cloud storage provider, they must pass normal authentication for this cloud storage provider. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Service Id |
String |
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136"). |
x |
|
User Id |
String |
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, |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Custom Settings Delete Custom Settings
<docusign:delete-v21-accounts-users-custom-settings-by-account-id-user-id>
Deletes the specified custom user settings for a single user.
Deleting Grouped Custom User Setting
If the custom user settings you want to delete 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 deleted.
This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/users/{userId}/custom_settings endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete User Profile Image
<docusign:delete-v21-accounts-users-profile-image-by-account-id-user-id>
Deletes the user profile image from the specified user’s profile. 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 DELETE request to the /v2.1/accounts/{accountId}/users/{userId}/profile/image endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete User Signature
<docusign:delete-v21-accounts-users-signatures-by-account-id-user-id-signature-id>
Removes the signature information for the 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 account. The signatureId 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 DELETE request to the /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
User Id |
String |
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, |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete User Signature Image
<docusign:delete-v21-accounts-users-signatures-by-account-id-user-id-signature-id-image-type>
Deletes the specified initials image or signature image for the specified user. The function deletes one or the other of the image types, to delete both the initials image and signature image you must call the endpoint twice. 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 DELETE request to the /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Image Type |
String |
Specificies the type of image. Valid values are: - |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
User Id |
String |
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, |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Workspace
<docusign:delete-v21-accounts-workspaces-by-account-id-workspace-id>
Deletes an existing workspace (logically). This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/workspaces/{workspaceId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Workspace Id |
String |
The ID of the workspace. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Workspace Items
<docusign:delete-v21-accounts-workspaces-folders-by-account-id-workspace-id-folder-id>
This method deletes one or more files or sub-folders from a workspace folder or root. Note: To delete items from a workspace, the status of the workspace must be active. This operation makes an HTTP DELETE request to the /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Folder Id |
String |
The ID of the folder. |
x |
|
Workspace Id |
String |
The ID of the workspace. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Notary Jurisdiction
<docusign:delete-v21-current-user-notary-jurisdictions-by-jurisdiction-id>
Deletes the specified jurisdiction. This operation makes an HTTP DELETE request to the /v2.1/current_user/notary/jurisdictions/{jurisdictionId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Jurisdiction Id |
String |
The ID of the jurisdiction. The following jurisdictions are supported:
|
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Delete Request Logs
<docusign:delete-v21-diagnostics-request-logs>
Deletes the request log files. This operation makes an HTTP DELETE request to the /v2.1/diagnostics/request_logs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Service Information Get Service Information
<docusign:get-service-information>
Retrieves the available REST API versions.
DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information
You do not need an integrator key to view the REST API versions and resources. This operation makes an HTTP GET request to the /service_information endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Service Information Get Resource Information
<docusign:get-v21>
Retrieves the base resources available for the DocuSign REST APIs. You do not need an integrator key to view the REST API versions and resources, for example, https://demo.docusign.net/restapi/v2 lists all of the base resources available in version 2 of the REST API on the DocuSign Demo system. To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL, for example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.
This operation makes an HTTP GET request to the /v2.1 endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Charges Get Account Billing Charges
<docusign:get-v21-accounts-billing-charges-by-account-id>
Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_charges endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Include charges |
String |
Specifies which billing charges to return. Valid values are: * envelopes * seats |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Invoices Get Billing Invoices
<docusign:get-v21-accounts-billing-invoices-by-account-id>
Retrieves a list of invoices for the account. If the from date or to date queries are not specified, the response returns invoices for the last 365 days. Privileges required: account administrator This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_invoices endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
From date |
String |
Specifies the date/time of the earliest invoice in the account to retrieve. |
||
To date |
String |
Specifies the date/time of the latest invoice in the account to retrieve. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Invoices Get Billing Invoice
<docusign:get-v21-accounts-billing-invoices-by-account-id-invoice-id>
Retrieves the specified invoice.
Note: If the pdfAvailable property in the response is set to true, you can download a PDF version of the invoice. To download the PDF, make the call again and change the value of the Accept property in the header to Accept: application/pdf.
Privileges required: account administrator
The response returns a list of charges and information about the charges. Quantities are usually shown as 'unlimited' or an integer. Amounts are shown in the currency set for the account.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_invoices/{invoiceId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Invoice Id |
String |
Invoice Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Invoices Get Billing Invoices Past Due
<docusign:get-v21-accounts-billing-invoices-past-due-by-account-id>
Returns a list past due invoices for the account and notes if payment can be made through the REST API.
Privileges Required: account administrator
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_invoices_past_due endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Payments Get Payment List
<docusign:get-v21-accounts-billing-payments-by-account-id>
Retrieves a list containing information about one or more payments. If the from date or to date queries are not used, the response returns payment information for the last 365 days.
Privileges required: account administrator
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_payments endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
From date |
String |
Specifies the date/time of the earliest payment in the account to retrieve. |
||
To date |
String |
Specifies the date/time of the latest payment in the account to retrieve. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Billing Payments Get Payment
<docusign:get-v21-accounts-billing-payments-by-account-id-payment-id>
Retrieves the information for a specified payment. Privileges required: account administrator This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_payments/{paymentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Payment Id |
String |
Payment Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Billing Plan
<docusign:get-v21-accounts-billing-plan-by-account-id>
Retrieves the billing plan information for the specified account, including the current billing plan, successor plans, billing address, and billing credit card. By default the successor plan and credit card information is included in the response. You can exclude this information from the response by adding the appropriate optional query string and setting it to false.
The response returns the billing plan information, including the currency code, for the plan.
Note: When credit card number information displays, a mask is applied to the response so that only the last 4 digits of the card number are visible.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_plan endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Include credit card information |
String |
When set to true, payment information including credit card information will show in the return. |
||
Include metadata |
String |
When set to true, the |
||
Include successor plans |
String |
When set to true, excludes successor information from the response. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Credit Card Info
<docusign:get-v21-accounts-billing-plan-credit-card-by-account-id>
This method returns information about a credit card associated with an account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_plan/credit_card endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Downgrade Request Billing Info
<docusign:get-v21-accounts-billing-plan-downgrade-by-account-id>
Billing Plan Get Downgrade Request Billing Info This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/billing_plan/downgrade endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Brands
<docusign:get-v21-accounts-brands-by-account-id>
This method returns details about all of the brands associated with an account, including the default brand profiles.
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 GET request to the /v2.1/accounts/{accountId}/brands endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Exclude distributor brand |
String |
When true, excludes distributor brand information from the response set. |
||
Include logos |
String |
When true, the URIs for the logos associated with the brand are included in the response. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Brand
<docusign:get-v21-accounts-brands-by-account-id-brand-id>
This method returns details about 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 GET request to the /v2.1/accounts/{accountId}/brands/{brandId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Brand Id |
String |
The ID of the brand. |
x |
|
Include external references |
String |
When true, the landing pages and links associated with the brand are included in the response. |
||
Include logos |
String |
When true, the URIs for the logos associated with the brand are included in the response. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Export Get Brand Export File
<docusign:get-v21-accounts-brands-file-by-account-id-brand-id>
This method exports information about a brand to an XML file.
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 GET request to the /v2.1/accounts/{accountId}/brands/{brandId}/file endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Brand Id |
String |
The ID of the brand. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Brand Logo
<docusign:get-v21-accounts-brands-logos-by-account-id-brand-id-logo-type>
This method returns a specific logo that is used in a 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 GET request to the /v2.1/accounts/{accountId}/brands/{brandId}/logos/{logoType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Brand Id |
String |
The ID of the brand. |
x |
|
Logo Type |
String |
The type of logo. Valid values are: - |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Brand Resources List
<docusign:get-v21-accounts-brands-resources-by-account-id-brand-id>
This method returns metadata about the branding resources that are associated with an account.
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 GET request to the /v2.1/accounts/{accountId}/brands/{brandId}/resources endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Brand Id |
String |
The ID of the brand. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Brand Resources
<docusign:get-v21-accounts-brands-resources-by-account-id-brand-id-resource-content-type>
This method returns a specific branding resource file. A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.
Important: 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.
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 GET request to the /v2.1/accounts/{accountId}/brands/{brandId}/resources/{resourceContentType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Brand Id |
String |
The ID of the brand. |
x |
|
Resource Content Type |
String |
The type of brand resource file to return. Valid values are: - |
x |
|
langcode |
String |
The ISO 3166-1 alpha-2 codes for the languages that the brand supports. |
||
Return master |
String |
Specifies which resource file data to return. When true, only the master resource file is returned. When false, only the elements that you modified are returned. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 V2Batch Get Bulk Send Batches
<docusign:get-v21-accounts-bulk-send-batch-by-account-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/bulk_send_batch endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Batch ids |
String |
Batch ids |
||
count |
String |
The maximum number of results to return. |
||
Start position |
String |
The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image. |
||
status |
String |
The status of the item. |
||
Output Mime Type |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Bulk Send V2Batch Get Bulk Send Batch Status
<docusign:get-v21-accounts-bulk-send-batch-by-account-id-bulk-send-batch-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/bulk_send_batch/{bulkSendBatchId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Bulk Send Batch Id |
String |
Bulk Send Batch Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Bulk Send Lists
<docusign:get-v21-accounts-bulk-send-lists-by-account-id>
This method returns a list of bulk send lists belonging to the current user, as well as basic information about each list. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/bulk_send_lists endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Bulk Send List
<docusign:get-v21-accounts-bulk-send-lists-by-account-id-bulk-send-list-id>
This method returns all of the details associated with a specific bulk send list that belongs to the current user. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Bulk Send List Id |
String |
The GUID of the bulk send list. This property is created after you post a new bulk send list. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Accounts Get Account
<docusign:get-v21-accounts-by-account-id>
Retrieves the account information for the specified account.
Response The canUpgrade property contains is a Boolean that indicates whether the account can be upgraded through the API.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Include account settings |
String |
When set to true, includes account settings (defined by the [ |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Chunked Upload
<docusign:get-v21-accounts-chunked-uploads-by-account-id-chunked-upload-id>
Returns the details (but not the content) about a chunked upload.
Note: You cannot obtain details about a chunked upload that has expired, been deleted, or consumed by other actions.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/chunked_uploads/{chunkedUploadId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Chunked Upload Id |
String |
The ID of the chunked upload. |
x |
|
include |
String |
(Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Connect Configs
<docusign:get-v21-accounts-connect-by-account-id>
Retrieves all the DocuSign Custom Connect definitions for the specified account.
Note: Connect must be enabled for your account to use this function. This does not retrieve information for Connect configurations for Box, eOriginal, or Salesforce.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Connect Config
<docusign:get-v21-accounts-connect-by-account-id-connect-id>
Retrieves the information for the specified DocuSign Connect configuration.
Note: Connect must be enabled for your account to use this function.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect/{connectId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Connect Id |
String |
The ID of the custom Connect configuration being accessed. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Failures Get Connect Logs
<docusign:get-v21-accounts-connect-failures-by-account-id>
Retrieves the Connect failure log information. You can use this log to determine which envelopes failed to post, to create a republish request. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect/failures endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
From date |
String |
The start date for a date range in UTC DateTime format. Note: If this property is null, no date filtering is applied. |
||
To date |
String |
The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. Note: If this property is null, the value defaults to the current date. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Log Get Connect Logs
<docusign:get-v21-accounts-connect-logs-by-account-id>
Retrieves a list of connect log entries for your account.
Note: The enableLog setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect/logs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
From date |
String |
The start date for a date range in UTC DateTime format. Note: If this property is null, no date filtering is applied. |
||
To date |
String |
The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. Note: If this property is null, the value defaults to the current date. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Log Get Connect Log
<docusign:get-v21-accounts-connect-logs-by-account-id-log-id>
Retrieves the specified Connect log entry for your account.
Note: The enableLog setting in the Connect configuration must be set to true to enable logging. If logging is not enabled, then no log entries are recorded.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect/logs/{logId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Log Id |
String |
The ID of the Connect log entry. |
x |
|
Additional info |
String |
When set to true, the response includes the |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Connect Users
<docusign:get-v21-accounts-connect-users-by-account-id-connect-id>
Returns users from the configured Connect service. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/connect/{connectId}/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Connect Id |
String |
The ID of the custom Connect configuration being accessed. |
x |
|
List included users |
String |
List included users |
||
count |
String |
Optional. Number of items to return. |
||
Email substring |
String |
Filters returned user records by full email address or a substring of email address. |
||
User name substring |
String |
Filters results based on a full or partial user name. Note: When you enter a partial user name, you do not use a wildcard character. |
||
status |
String |
Filters the results by user status. You can specify a comma-separated list of the following statuses: * ActivationRequired * ActivationSent * Active * Closed * Disabled |
||
Start position |
String |
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 |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Consumer Disclosure Get Consumer Disclosure
<docusign:get-v21-accounts-consumer-disclosure-by-account-id>
Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. The default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties. To set the language of the disclosure that you want to retrieve, use the optional langCode query parameter.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/consumer_disclosure endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Lang Code |
String |
(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Consumer Disclosure Lang Code
<docusign:get-v21-accounts-consumer-disclosure-by-account-id-lang-code>
Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) associated with the account. To set the language of the disclosure that you want to retrieve, use the optional langCode query parameter.
Note: The text of the default disclosure is always in English, but if you are using a custom disclosure and have created versions of it in different signer languages, you can use the langCode parameter to specify the signer language version that you want to retrieve.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/consumer_disclosure/{langCode} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Lang Code |
String |
(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic ( |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Contact By Id
<docusign:get-v21-accounts-contacts-by-account-id-contact-id>
This method returns one or more contacts associated with a DocuSign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] providers by using the cloud_provider query parameter. By default, contacts are retrieved from the DocuSign account’s default address book. To return a specific contact, use the contactId query parameter. To return all contacts associated with an account, omit this parameter. [CloudStorage]: /esign-rest-api/reference/CloudStorage/
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/contacts/{contactId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Contact Id |
String |
The ID of a contact person in the account''s address book. |
x |
|
Cloud provider |
String |
(Optional) The cloud provider from which to retrieve the contacts. Valid values are: - |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Account Custom Fields
<docusign:get-v21-accounts-custom-fields-by-account-id>
This method returns a list of the envelope and document custom fields associated with an account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/custom_fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Attachments
<docusign:get-v21-accounts-envelopes-attachments-by-account-id-envelope-id>
Gets attachments. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Attachment
<docusign:get-v21-accounts-envelopes-attachments-by-account-id-envelope-id-attachment-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/attachments/{attachmentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Attachment Id |
String |
The unique identifier for the attachment. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Audit Events Get Audit Events
<docusign:get-v21-accounts-envelopes-audit-events-by-account-id-envelope-id>
Gets the envelope audit events for the specified envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/audit_events endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Envelopes
<docusign:get-v21-accounts-envelopes-by-account-id>
Retrieves a list of envelopes that match your request. A large set of optional filters let you filter by date, by envelope ID, or by status codes. Your request must include one or more of the following parameters:
-
from_date -
envelope_ids -
transaction_ids
Getting envelope status using transaction_ids is useful for offline signing situations where it can be used determine if an envelope was created or not. It can be used for the cases where a network connection was lost, before the envelope status could be returned.
To avoid unnecessary database queries, the DocuSign signature platform first checks requests to ensure that the filter set supplied does not result in a zero-size response before querying the database. For example, for a request with a from_to_status of delivered and a current status of created,sent, DocuSign will always return an empty list. This is because the request translates to: find the envelopes that were delivered between the from_date and to_date dates that have a current status of created or sent. Since an envelope that has been delivered can never have a status of created or sent, a zero-size response would be generated.
In this case, DocuSign does not query the database and returns an empty list immediately. The following table shows the valid current envelope statuses (status parameter) for the different status qualifiers (from_to_status parameter) in the request.
If the status and status qualifiers in the API request do not contain any of the values shown in the Valid Current Statuses column, then an empty list is returned. Client applications should check that the statuses (status parameter) they are requesting make sense for a given from_to_status parameter value.
Status Qualifier (from_to_status) |
Effective Status Qualifier | Valid Current Statuses |
|---|---|---|
any (changed) |
StatusChanged |
any, created, sent, delivered, signed, completed, declined, voided, deleted |
created |
Created |
any, created, sent, delivered, signed, completed, declined, voided, deleted |
sent |
Sent |
any, sent, delivered, signed, completed, declined, voided, deleted |
delivered |
StatusChanged |
any, delivered, signed, completed, declined, voided, deleted |
signed |
StatusChanged |
any, signed, completed, declined, voided, deleted |
completed |
Completed |
any, completed, declined, voided, deleted |
declined |
StatusChanged |
any, declined, voided, deleted |
timedout always return zero results |
StatusChanged |
any, voided, deleted |
voided |
Voided |
any, voided, deleted |
deleted |
StatusChanged |
Extraneous results
In some cases, a request for a specific envelope status will include envelopes with additional statuses. For example, in a request with a from_date of 2017-01-01, a to_date of 2017-01-07 and the status qualifier (from_to_status) set to delivered, the response set might contain envelopes that were created during that time period, but not delivered during the time period. As a workaround, check the envelope status values in the result set as needed.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Include purge information |
String |
When set to true, information about envelopes that have been deleted is included in the response. |
||
Continuation token |
String |
A token returned in the response to a previous API call that is used to resume a search query from a specific point. |
||
count |
String |
Optional. Number of items to return. Currently there is no implicit maximum limit of the number of items that can be returned. |
||
From to status |
String |
The envelope status that you are checking for. Possible values are: - |
||
String |
Limit results to envelopes sent by the account user with this email address. |
|||
Search text |
String |
Free text search criteria that you can use to filter the list of envelopes that is returned. |
||
Ac status |
String |
Specifies the Authoritative Copy Status for the envelopes. The possible values are: - |
||
Envelope ids |
String |
Comma separated list of |
||
Folder types |
String |
A comma-separated list of folder types you want to retrieve envelopes from. Valid values are: - |
||
powerformids |
String |
A comma-separated list of |
||
User ID |
String |
The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account access can retrieve envelopes by user_id from the account. |
||
block |
String |
Reserved for DocuSign. |
||
Requester date format |
String |
Requester date format |
||
User filter |
String |
Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, |
||
order |
String |
Returns envelopes in either ascending ( |
||
status |
String |
A comma-separated list of current envelope statuses to included in the response. Possible values are: * |
||
Intersecting folder ids |
String |
A comma-separated list of folders that you want to get envelopes from. Valid values are: - |
||
Query budget |
String |
The time in seconds that the query should run before returning data. |
||
Order by |
String |
Sorts results according to a specific property. Valid values are: - |
||
include |
String |
Specifies additional information to return about the envelopes. Enter a comma-separated list, such as |
||
Custom field |
String |
Optional. Specifies a envelope custom field name and value searched for in the envelopes. Format: |
||
From date |
String |
Specifies the date and time to start looking for status changes. This parameter is required unless |
||
exclude |
String |
Excludes information from the response. Enter as a comma-separated list (, for example, |
||
Last queried date |
String |
Returns envelopes that were modified prior to the specified date and time. Example: |
||
Folder ids |
String |
Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder Guids or the following values: - |
||
Cdse mode |
String |
Reserved for DocuSign. |
||
User name |
String |
Limit results to envelopes sent by the account user with this user name. |
||
Start position |
String |
This value is supported and currently has no implicit maximum items. |
||
Transaction ids |
String |
A comma-separated list of envelope transaction IDs. Transaction IDs are only valid for seven days. |
||
To date |
String |
Specifies the date and time to stop looking for status changes. The default is the current date and time. Although you can use any date format supported by the .NET system library’s [ |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Envelope
<docusign:get-v21-accounts-envelopes-by-account-id-envelope-id>
Retrieves the overall status for the specified envelope. To get the status of a list of envelopes, use Envelope: listStatusChanges .
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Advanced update |
String |
When true, envelope information can be added or modified. |
||
include |
String |
Specifies additional information about the envelope to return. Enter a comma-separated list, such as |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Comments Get Comments Transcript
<docusign:get-v21-accounts-envelopes-comments-transcript-by-account-id-envelope-id>
Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope.
Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the accountSettingsInformation object, set the enableSigningExtensionComments property to true).
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/comments/transcript endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
encoding |
String |
(Optional) The encoding to use for the file. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Custom Fields
<docusign:get-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>
Retrieves the custom field information for the specified envelope. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes, and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients. There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. With a list custom field, the sender selects the value of the field from a premade list.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Documents
<docusign:get-v21-accounts-envelopes-documents-by-account-id-envelope-id>
Retrieves a list of documents associated with the specified envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Include tabs |
String |
When set to true, information about the tabs associated with the documents are included in the response. |
||
Shared user ID |
String |
The ID of a shared user that you want to impersonate to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the RADmin console). |
||
Include metadata |
String |
When set to true, the response includes metadata that indicates which properties the sender can edit. |
||
Include document size |
String |
Include document size |
||
Documents by userid |
String |
When set to true, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders. |
||
Recipient ID |
String |
Allows the sender to retrieve the documents as one of the recipients that they control. The |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Document
<docusign:get-v21-accounts-envelopes-documents-by-account-id-envelope-id-document-id>
Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
This parameter takes the following special keywords: - |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
certificate |
String |
When set to false, the envelope signing certificate is removed from the download. |
||
Shared user ID |
String |
The ID of a shared user that you want to impersonate to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the RADmin console). |
||
encrypt |
String |
When set to true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign. |
||
encoding |
String |
Reserved for DocuSign. |
||
Documents by userid |
String |
When set to true, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders. |
||
language |
String |
Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es). |
||
Show changes |
String |
When set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. |
||
Recipient ID |
String |
Allows the sender to retrieve the documents as one of the recipients that they control. The |
||
watermark |
String |
When set to true, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Document Fields
<docusign:get-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>
Retrieves the custom document field information from an existing envelope document. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Get Envelope Document Html Definitions
<docusign:get-v21-accounts-envelopes-documents-html-definitions-by-account-id-envelope-id-document-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/html_definitions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Page Images
<docusign:get-v21-accounts-envelopes-documents-pages-by-account-id-envelope-id-document-id>
Returns images of the pages in a document for display based on the parameters that you specify. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Max width |
String |
Sets the maximum width of the returned images in pixels. |
||
count |
String |
The maximum number of results to return. |
||
Max height |
String |
Sets the maximum height of the returned images in pixels. |
||
dpi |
String |
The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94. |
||
nocache |
String |
If true, using cache is disabled and image information is retrieved from a database. True is the default value. |
||
Show changes |
String |
If true, changes display in the user interface. |
||
Start position |
String |
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 |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Pages Get Page Image
<docusign:get-v21-accounts-envelopes-documents-pages-page-image-by-account-id-envelope-id-document-id-page-number>
Returns an image of a page in a document for display. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/page_image endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Page Number |
String |
The page number being accessed. |
x |
|
dpi |
String |
Sets the dots per inch (DPI) for the returned image. |
||
Max height |
String |
Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting. |
||
Max width |
String |
Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting. |
||
Show changes |
String |
When true, changes display in the user interface. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Page Tabs
<docusign:get-v21-accounts-envelopes-documents-pages-tabs-by-account-id-envelope-id-document-id-page-number>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Page Number |
String |
The page number being accessed. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Document Tabs
<docusign:get-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>
This method returns the tabs associated with a document. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Page numbers |
String |
Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs. Example: |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Get Document Templates
<docusign:get-v21-accounts-envelopes-documents-templates-by-account-id-envelope-id-document-id>
Retrieves the templates associated with a document in the specified envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
include |
String |
A comma-separated list that limits the results. Valid values are: * |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Email Settings
<docusign:get-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>
Retrieves the email override settings for the specified envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Form Data Get Form Data
<docusign:get-v21-accounts-envelopes-form-data-by-account-id-envelope-id>
This method downloads the envelope and field data from any in-process, completed, or canceled envelope that you sent or that is shared with you. Recipients who are also full administrators on an account can view form data for any envelopes that another user on the account has sent to them.
Note: To use this feature, the Sending Setting "Allow sender to download form data" must be enabled for the account.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/form_data endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Get Envelope Html Definitions
<docusign:get-v21-accounts-envelopes-html-definitions-by-account-id-envelope-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/html_definitions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Envelope Lock
<docusign:get-v21-accounts-envelopes-lock-by-account-id-envelope-id>
Retrieves general information about an envelope lock. If the call is made by the locked by user and the request has the same integrator key as original, then the X-DocuSign-Edit header and additional lock information is included in the response. This information enables users to recover a lost editing session token and the X-DocuSign-Edit header.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Envelopes Envelope Id Notification
<docusign:get-v21-accounts-envelopes-notification-by-account-id-envelope-id>
Retrieves the envelope notification, reminders and expirations, information for an existing envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/notification endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Recipients
<docusign:get-v21-accounts-envelopes-recipients-by-account-id-envelope-id>
Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. This method can also be used to retrieve the tab values. The currentRoutingOrder property of the response contains the routingOrder value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Include anchor tab locations |
String |
When set to true and |
||
Include extended |
String |
When set to true, the extended properties are included in the response. |
||
Include metadata |
String |
Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates). |
||
Include tabs |
String |
When set to true, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (false). |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Consumer Disclosure Envelope Id Recipient Id
<docusign:get-v21-accounts-envelopes-recipients-consumer-disclosure-by-account-id-envelope-id-recipient-id>
Retrieves the default, HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope that you specify. The default ERSD disclosure that DocuSign provides for the convenience of U.S.-based customers only. This default disclosure is only valid for transactions between U.S.-based parties. To set the language of the disclosure that you want to retrieve, use the optional langCode query parameter.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Lang Code |
String |
(Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported: - Arabic ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Consumer Disclosure Envelope Id Recipient Id Lang Code
<docusign:get-v21-accounts-envelopes-recipients-consumer-disclosure-by-account-id-envelope-id-recipient-id-lang-code>
Retrieves the HTML-formatted Electronic Record and Signature Disclosure (ERSD) for the envelope recipient that you specify. This disclosure might differ from the account-level disclosure, based on the signing brand applied to the envelope and the recipient’s language settings. To set the language of the disclosure that you want to retrieve, specify the langCode as either a path or query parameter.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure/{langCode} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Lang Code |
String |
(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a path parameter. The following languages are supported: - Arabic ( |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Lang Code |
String |
(Optional) The code for the signer language version of the disclosure that you want to retrieve, as a query parameter. The following languages are supported: - Arabic ( |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Recipient Document Visibility
<docusign:get-v21-accounts-envelopes-recipients-document-visibility-by-account-id-envelope-id-recipient-id>
This method returns information about document visibility for a recipient. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/document_visibility endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Recipient Initials Image
<docusign:get-v21-accounts-envelopes-recipients-initials-image-by-account-id-envelope-id-recipient-id>
Retrieves the initials image for the specified user. The image is returned in the same format as it was uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image. The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.
The signatureIdOrName paramter accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that do not properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only contain chromed images. If getting the non-chromed image fails, try getting the chromed image.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/initials_image endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Include chrome |
String |
The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Recipient Signature
<docusign:get-v21-accounts-envelopes-recipients-signature-by-account-id-envelope-id-recipient-id>
Retrieves signature information for a signer or sign-in-person recipient. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Recipient Signature Image
<docusign:get-v21-accounts-envelopes-recipients-signature-image-by-account-id-envelope-id-recipient-id>
Retrieves the specified user signature image. The image is returned in the same format as uploaded. In the request you can specify if the chrome (the added line and identifier around the initial image) is returned with the image.
The userId specified in the endpoint must match the authenticated user’s user ID and the user must be a member of the account.
The signatureIdOrName parameter accepts signature ID or signature name. DocuSign recommends you use signature ID (signatureId), since some names contain characters that don’t properly URL encode. If you use the user name, it is likely that the name includes spaces and you might need to URL encode the name before using it in the endpoint. For example: "Bob Smith" to "Bob%20Smith" Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/signature_image endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Include chrome |
String |
When set to true, the response includes the chromed version of the signature image. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Recipient Tabs
<docusign:get-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>
Retrieves information about the tabs associated with a recipient. You can make a single API call to get all the tab values and information from a given, completed envelope in addition to draft ones. Tab values can be retrieved by using the EnvelopeRecipients:list method with query parameter include_tabs set to "true".
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Include anchor tab locations |
String |
When set to true, all tabs with anchor tab properties are included in the response. The default value is false. |
||
Include metadata |
String |
When set to true, the response includes metadata indicating which properties are editable. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Tabs Blob
<docusign:get-v21-accounts-envelopes-tabs-blob-by-account-id-envelope-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Get Envelope Templates
<docusign:get-v21-accounts-envelopes-templates-by-account-id-envelope-id>
This returns a list of the server-side templates, their name and ID, used in an envelope. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
include |
String |
The possible value is |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Envelope Transfer Rules
<docusign:get-v21-accounts-envelopes-transfer-rules-by-account-id>
This method retrieves a list of envelope transfer rules associated with an account.
Note: Only Administrators can create and use envelope transfer rules. In addition, to use envelope transfer rules, the Transfer Custody feature must be enabled for your account.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/transfer_rules endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
count |
String |
(Optional) The maximum number of results to return. |
||
Start position |
String |
(Optional) The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Envelope Workflow Definition
<docusign:get-v21-accounts-envelopes-workflow-by-account-id-envelope-id>
Returns an envelope’s workflow definition if the envelope specified by envelopeId has one. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Favorite Templates
<docusign:get-v21-accounts-favorite-templates-by-account-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/favorite_templates endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Folders
<docusign:get-v21-accounts-folders-by-account-id>
Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the template query string parameter. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/folders endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User filter |
String |
Narrows down the resulting folder list by the following values: - |
||
Include items |
String |
Indicates whether folder items are included in the response. If this parameter is omitted, the default is false. |
||
include |
String |
A comma-separated list of folder types to include in the response. Valid values are: - |
||
template |
String |
This parameter is deprecated as of version 2.1. Use |
||
Start position |
String |
The position within the total result set from which to start returning values. |
||
Output Mime Type |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Folders Get Folder Items
<docusign:get-v21-accounts-folders-by-account-id-folder-id>
Retrieves a list of the envelopes in the specified folder. You can narrow the query by specifying search criteria in the query string parameters. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/folders/{folderId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Folder Id |
String |
The ID of the folder. |
x |
|
Search text |
String |
Reserved for DocuSign. |
||
Owner name |
String |
Reserved for DocuSign. |
||
Include items |
String |
Indicates whether folder items are included in the response. If this parameter is omitted, the default is false. |
||
status |
String |
Reserved for DocuSign. |
||
From date |
String |
Reserved for DocuSign. |
||
Start position |
String |
Reserved for DocuSign. |
||
Owner email |
String |
Reserved for DocuSign. |
||
To date |
String |
Reserved for DocuSign. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Group Brands
<docusign:get-v21-accounts-groups-brands-by-account-id-group-id>
This method returns information about the brands associated with a group. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/groups/{groupId}/brands endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Group Id |
String |
The ID of the group. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Groups
<docusign:get-v21-accounts-groups-by-account-id>
Retrieves information about groups associated with the account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/groups endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
count |
String |
Number of records to return. The number must be greater than 1 and less than or equal to 100. |
||
Search text |
String |
Filters the results of a GET request based on the text that you specify. |
||
Group type |
String |
Group type |
||
Include usercount |
String |
When set to true, every group returned in the response includes a |
||
Start position |
String |
The starting value for the list. |
||
Output Mime Type |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Groups Get Group Users
<docusign:get-v21-accounts-groups-users-by-account-id-group-id>
Retrieves a list of users in a group. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/groups/{groupId}/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Group Id |
String |
The ID of the group being accessed. |
x |
|
count |
String |
Number of records to return. The number must be greater than 1 and less than or equal to 100. |
||
Start position |
String |
Starting value for the list. |
||
Output Mime Type |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Account Identity Verification Get Account Identity Verification
<docusign:get-v21-accounts-identity-verification-by-account-id>
This method returns a list of Identity Verification workflows that are available to an account. Note: To use this method, you must either be an account administrator or a sender. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/identity_verification endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Payment Gateway Accounts Get All Payment Gateway Accounts
<docusign:get-v21-accounts-payment-gateway-accounts-by-account-id>
This method returns a list of payment gateway accounts and basic information about them. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/payment_gateway_accounts endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Permission Profiles
<docusign:get-v21-accounts-permission-profiles-by-account-id>
This method returns a list of permission profiles that are associated with an account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/permission_profiles endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
include |
String |
A comma-separated list of additional properties to return in the response. Valid values are: - |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Permission Profile
<docusign:get-v21-accounts-permission-profiles-by-account-id-permission-profile-id>
This method returns information about a specific permission profile that is associated with an account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Permission Profile Id |
String |
The ID of the permission profile. Possible values include: - |
x |
|
include |
String |
A comma-separated list of additional properties to return in the response. The only valid value for this request is |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Get Power Forms List
<docusign:get-v21-accounts-powerforms-by-account-id>
This method returns a list of PowerForms that are available to the user. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/powerforms endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
From date |
String |
(Optional) The start date for a date range. Note: If no value is provided, no date filtering is applied. |
||
order |
String |
(Optional) The order in which to sort the results. Valid values are: * |
||
Order by |
String |
(Optional) The file attribute to use to sort the results. Valid values are: * |
||
To date |
String |
(Optional) The end date for a date range. Note: If no value is provided, this property defaults to the current date. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Get Power Form
<docusign:get-v21-accounts-powerforms-by-account-id-power-form-id>
This method returns detailed information about a specific PowerForm. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/powerforms/{powerFormId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Power Form Id |
String |
The ID of the PowerForm. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Get Power Form Data
<docusign:get-v21-accounts-powerforms-form-data-by-account-id-power-form-id>
This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the Accept header.
This header accepts the following values:
-
application/json: JSON format -
application/xml: XML format -
text/csv: Comma-separated value (CSV) format
Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Power Form Id |
String |
The ID of the PowerForm. |
x |
|
Data layout |
String |
The layout in which to return the PowerForm data. Valid values are: - |
||
From date |
String |
The start date for a date range in UTC DateTime format. Note: If this property is null, no date filtering is applied. |
||
To date |
String |
The end date of a date range in UTC DateTime format. The default value is |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Get Power Forms Senders
<docusign:get-v21-accounts-powerforms-senders-by-account-id>
This method returns a list of users who have sent PowerForms. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/powerforms/senders endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Start position |
String |
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 |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Accounts Get Provisioning
<docusign:get-v21-accounts-provisioning>
Retrieves the account provisioning information for the account. This operation makes an HTTP GET request to the /v2.1/accounts/provisioning endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Recipient Names Get Recipient Names
<docusign:get-v21-accounts-recipient-names-by-account-id>
Retrieves a list of all of the names associated with the email address that you pass in. This list can include variants of a single recipient''s name that are used for signing, as well as the names of multiple different recipients.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/recipient_names endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
(Required) The external account number (int) or account ID GUID. |
x |
|
String |
The email address for which you want to retrieve recipient names. |
|||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Get Report In Product List
<docusign:get-v21-accounts-reports-by-account-id>
Reports In Product Get Report In Product List This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/reports endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Get Report In Product
<docusign:get-v21-accounts-reports-by-account-id-id>
Reports In Product Get Report In Product This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/reports/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
ID |
String |
A unique ID for the Salesforce object. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Signature Providers Get Seal Providers
<docusign:get-v21-accounts-seals-by-account-id>
Account Signature Providers Get Seal Providers This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/seals endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Search Folders Get Search Folder Contents
<docusign:get-v21-accounts-search-folders-by-account-id-search-folder-id>
This method is deprecated in API v2.1. Use Envelopes::listStatusChanges instead. Retrieves a list of items that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/search_folders/{searchFolderId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Search Folder Id |
String |
Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature. |
x |
|
count |
String |
Specifies the number of records returned in the cache. The number must be greater than 0 and less than or equal to 100. |
||
all |
String |
Specifies that all envelopes that match the criteria are returned. |
||
Include recipients |
String |
When set to true, the recipient information is returned in the response. |
||
order |
String |
Specifies the order in which the list is returned. Valid values are: |
||
Order by |
String |
Specifies the property used to sort the list. Valid values are: |
||
From date |
String |
Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days. |
||
Start position |
String |
Specifies the starting location in the result set of the items that are returned. |
||
To date |
String |
Specifies the end of the date range to return. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
BCCEmail Archive Get BCCEmail Archive List
<docusign:get-v21-accounts-settings-bcc-email-archives-by-account-id>
This method retrieves all of the BCC email archive configurations associated with an account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/settings/bcc_email_archives endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
count |
String |
(Optional) The maximum number of results to return. |
||
Start position |
String |
(Optional) The index position within the total result set from which to start returning values. The default value is |
||
Output Mime Type |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
BCCEmail Archive Get BCCEmail Archive History List
<docusign:get-v21-accounts-settings-bcc-email-archives-by-account-id-bcc-email-archive-id>
This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Bcc Email Archive Id |
String |
The ID of the BCC email archive configuration. |
x |
|
count |
String |
(Optional) The maximum number of results (changes) to return. |
||
Start position |
String |
(Optional) The index position within the total result set from which to start returning values. The default value is |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Settings Get Settings
<docusign:get-v21-accounts-settings-by-account-id>
Retrieves the account settings information for the specified account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/settings endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
ENote Configuration Get ENote Configuration
<docusign:get-v21-accounts-settings-enote-configuration-by-account-id>
ENote Configuration Get ENote Configuration This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/settings/enote_configuration endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Purge Configuration Get Envelope Purge Configuration
<docusign:get-v21-accounts-settings-envelope-purge-configuration-by-account-id>
An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays). This method retrieves the current envelope purge configuration for your account.
Note: To use this method, you must be an account administrator.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/settings/envelope_purge_configuration endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Defaults Get Notification Defaults
<docusign:get-v21-accounts-settings-notification-defaults-by-account-id>
This method returns the default settings for the email notifications that signers and senders receive about envelopes. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/settings/notification_defaults endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Password Rules Get Account Password Rules
<docusign:get-v21-accounts-settings-password-rules-by-account-id>
This method retrieves the password rules for an account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/settings/password_rules endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Tab Settings Get Tab Settings
<docusign:get-v21-accounts-settings-tabs-by-account-id>
This method returns information about the tab types and tab functionality that is currently enabled for an account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/settings/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Shared Access Get Shared Access
<docusign:get-v21-accounts-shared-access-by-account-id>
Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves, and the returned information is limited to retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the shared parameter to shared_from.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/shared_access endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
count |
String |
Specifies the maximum number of results included in the response. If no value is specified, this defaults to 1000. |
||
Search text |
String |
Filter user names based on the specified string. The wild-card ''*'' (asterisk) can be used in the string. |
||
shared |
String |
A comma-separated list of sharing filters that specifies which users appear in the response. - |
||
Envelopes not shared user status |
String |
This query parameter works in conjunction with |
||
Folder ids |
String |
A comma-separated list of folder IDs for which to return shared item information. If |
||
User ids |
String |
A comma-separated list of user IDs for whom the shared item information is being requested. |
||
Item type |
String |
Specifies the type of shared item being requested. The possible values are: - |
||
Start position |
String |
If the number of responses is greater than |
||
Output Mime Type |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Account Signature Providers Get Signature Providers
<docusign:get-v21-accounts-signature-providers-by-account-id>
Returns a list of signature providers that the specified account can use. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/signatureProviders endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Get Account Signatures
<docusign:get-v21-accounts-signatures-by-account-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/signatures endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Stamp format |
String |
Stamp format |
||
Stamp name |
String |
Stamp name |
||
Stamp type |
String |
Stamp type |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Get Account Signature
<docusign:get-v21-accounts-signatures-by-account-id-signature-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/signatures/{signatureId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Get Account Signature Image
<docusign:get-v21-accounts-signatures-by-account-id-signature-id-image-type>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Image Type |
String |
Specificies the type of image. Valid values are: - |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
Include chrome |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Get Signing Groups
<docusign:get-v21-accounts-signing-groups-by-account-id>
Retrieves a list of all signing groups in the specified account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/signing_groups endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Group type |
String |
Group type |
||
Include users |
String |
When set to true, the response includes the signing group members. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Get Signing Group
<docusign:get-v21-accounts-signing-groups-by-account-id-signing-group-id>
Retrieves information, including group member information, for the specified signing group. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/signing_groups/{signingGroupId} endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signing Group Id |
String |
Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Get Signing Group Users
<docusign:get-v21-accounts-signing-groups-users-by-account-id-signing-group-id>
Retrieves the list of members in the specified Signing Group. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signing Group Id |
String |
Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Supported Languages Get Supported Languages
<docusign:get-v21-accounts-supported-languages-by-account-id>
Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient’s email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.
Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the emailBody and emailSubject of the notification is not translated, and appears exactly as you enter it.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/supported_languages endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Tab Definitions
<docusign:get-v21-accounts-tab-definitions-by-account-id>
Retrieves a list of all tabs associated with the account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/tab_definitions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Custom tab only |
String |
When set to true, only custom tabs are returned in the response. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Tab Get Custom Tab
<docusign:get-v21-accounts-tab-definitions-by-account-id-custom-tab-id>
Retrieves information about the requested custom tab on the specified account. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/tab_definitions/{customTabId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Custom Tab Id |
String |
The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Get Templates
<docusign:get-v21-accounts-templates-by-account-id>
Retrieves the list of templates for the specified account. The request can be limited to a specific folder. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Shared by me |
String |
If |
||
count |
String |
The number of records to return in the cache. |
||
Is download |
String |
When set to true, downloads the templates listed in |
||
Search text |
String |
The search text to use to search the names of templates. |
||
Used to date |
String |
End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date. |
||
Used from date |
String |
Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used. |
||
Template ids |
String |
A comma-separated list of template ids to download. This value is valid only when |
||
Search fields |
String |
A comma-separated list of additional template properties to search. - |
||
Folder types |
String |
The type of folder to return templates for. Possible values are: - |
||
Created to date |
String |
Lists templates modified before this date. |
||
User ID |
String |
The ID of the user. |
||
Created from date |
String |
Lists templates created on or after this date. |
||
User filter |
String |
Filters the templates in the response. Valid values are: - |
||
order |
String |
Specifies the sort order of the search results. Valid values are: - |
||
Order by |
String |
Specifies how the search results are listed. Valid values are: - |
||
include |
String |
A comma-separated list of additional template attributes to include in the response. Valid values are: - |
||
From date |
String |
Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created. |
||
Folder ids |
String |
A comma-separated list of folder ID GUIDs. |
||
Modified to date |
String |
Lists templates modified before this date. |
||
Start position |
String |
The starting zero-based index position for the first template to show in the response. This value must be greater than or equal to |
||
Modified from date |
String |
Lists templates modified on or after this date. |
||
To date |
String |
The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. Note: If this property is null, the value defaults to the current date. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Get Template
<docusign:get-v21-accounts-templates-by-account-id-template-id>
Retrieves the definition of the specified template. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
include |
String |
A comma-separated list of additional template attributes to include in the response. Valid values are: - |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Custom Fields
<docusign:get-v21-accounts-templates-custom-fields-by-account-id-template-id>
Retrieves the custom document field information from an existing template. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Documents
<docusign:get-v21-accounts-templates-documents-by-account-id-template-id>
Retrieves a list of documents associated with the specified template. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Include tabs |
String |
Reserved for DocuSign. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Document
<docusign:get-v21-accounts-templates-documents-by-account-id-template-id-document-id>
This method retrieves one or more PDF documents from the template that you specify. You can specify the ID of the document to retrieve, or pass in the value combined to retrieve all documents in the template as a single PDF file. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
encrypt |
String |
When set to true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign. |
||
Show changes |
String |
When set to true, any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional signatures or initials are outlined in red. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Document Fields
<docusign:get-v21-accounts-templates-documents-fields-by-account-id-template-id-document-id>
This method retrieves the custom document fields for an existing template document. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Get Template Document Html Definitions
<docusign:get-v21-accounts-templates-documents-html-definitions-by-account-id-template-id-document-id>
Responsive Html Get Template Document Html Definitions This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/html_definitions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Page Images
<docusign:get-v21-accounts-templates-documents-pages-by-account-id-template-id-document-id>
Returns images of the pages in a template document for display based on the parameters that you specify. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
(Required) The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
(Required) The ID of the document. |
x |
|
Template Id |
String |
(Required) The ID of the template. |
x |
|
Max width |
String |
Sets the maximum width of the returned images in pixels. |
||
count |
String |
The maximum number of results to return. |
||
Max height |
String |
Sets the maximum height of the returned images in pixels. |
||
dpi |
String |
The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94. |
||
nocache |
String |
If true, using cache is disabled and image information is retrieved from a database. True is the default value. |
||
Show changes |
String |
If true, changes display in the user interface. |
||
Start position |
String |
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 |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Pages Get Template Page Image
<docusign:get-v21-accounts-templates-documents-pages-page-image-by-account-id-template-id-document-id-page-number>
Retrieves a page image for display from the specified template. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Page Number |
String |
The page number being accessed. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
dpi |
String |
The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94. |
||
Max height |
String |
Sets the maximum height of the returned images in pixels. |
||
Max width |
String |
Sets the maximum width of the returned images in pixels. |
||
Show changes |
String |
Show changes |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Page Tabs
<docusign:get-v21-accounts-templates-documents-pages-tabs-by-account-id-template-id-document-id-page-number>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Page Number |
String |
The page number being accessed. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Document Tabs
<docusign:get-v21-accounts-templates-documents-tabs-by-account-id-template-id-document-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Page numbers |
String |
Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids. Example: |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Responsive Html Get Template Html Definitions
<docusign:get-v21-accounts-templates-html-definitions-by-account-id-template-id>
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/html_definitions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Lock
<docusign:get-v21-accounts-templates-lock-by-account-id-template-id>
Retrieves general information about the template lock. If the call is made by the user who has the lock and the request has the same integration key as original, then the X-DocuSign-Edit header field and additional lock information is included in the response. This enables users to recover a lost editing session token and the X-DocuSign-Edit header.
This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/lock endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Templates Template Id Notification
<docusign:get-v21-accounts-templates-notification-by-account-id-template-id>
Retrieves the envelope notification, reminders and expirations, information for an existing template. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/notification endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Bulk Recipients
<docusign:get-v21-accounts-templates-recipients-bulk-recipients-by-account-id-template-id-recipient-id>
Retrieves the bulk recipient file information from a template that has a bulk recipient. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Include tabs |
String |
When set to true, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (false). |
||
Start position |
String |
The starting position of the results set. |
||
Output Mime Type |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Recipients Get Template Recipients
<docusign:get-v21-accounts-templates-recipients-by-account-id-template-id>
Retrieves the information for all recipients in the specified template. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Include anchor tab locations |
String |
When set to true and |
||
Include extended |
String |
When set to true, the extended properties are included in the response. |
||
Include tabs |
String |
When set to true, the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (false). |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Recipient Document Visibility
<docusign:get-v21-accounts-templates-recipients-document-visibility-by-account-id-template-id-recipient-id>
This method returns information about document visibility for a template recipient. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Recipient Tabs
<docusign:get-v21-accounts-templates-recipients-tabs-by-account-id-template-id-recipient-id>
Gets the tabs information for a signer or sign-in-person recipient in a template. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Include anchor tab locations |
String |
When set to true, all tabs with anchor tab properties are included in the response. The default value is false. |
||
Include metadata |
String |
When set to true, the response includes metadata indicating which properties are editable. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Get Template Workflow Definition
<docusign:get-v21-accounts-templates-workflow-by-account-id-template-id>
Returns template''s workflow definition if the template specified by templateId has one. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/templates/{templateId}/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Unsupported File Types Get Unsupported File Types
<docusign:get-v21-accounts-unsupported-file-types-by-account-id>
Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/unsupported_file_types endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Users Get Users
<docusign:get-v21-accounts-users-by-account-id>
Retrieves the list of users for the specified account. The response returns the list of users for the account, with information about the result set. If the additional_info query is added to the endpoint and set to true, full user information is returned for each user. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
(Required) The external account number (int) or account ID GUID. |
x |
|
Group ID |
String |
Filters results based on one or more group IDs. |
||
count |
String |
The number of records to return. This number must be greater than |
||
String |
Filters results based on the email address associated with the user that you want to return. Note: You can use either this parameter or the |
|||
Include usersettings for csv |
String |
When set to true, the response includes the |
||
Email substring |
String |
Filters results based on a fragment of an email address. For example, you could enter |
||
Additional info |
String |
When set to true, the custom settings information is returned for each user in the account. If this parameter is omitted, the default behavior is false. |
||
Login status |
String |
When set to true, the response includes the login status of each user. |
||
User name substring |
String |
Filters results based on a full or partial user name. Note: When you enter a partial user name, you do not use a wildcard character. |
||
Not group ID |
String |
Return user records excluding the specified group IDs. |
||
status |
String |
Filters results by user account status. Possible values are: * |
||
Start position |
String |
The position within the total result set from which to start returning values. |
||
Output Mime Type |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
User Get User
<docusign:get-v21-accounts-users-by-account-id-user-id>
Retrieves the user information for the specified user. To return additional user information that details the last login date, login status, and the user’s password expiration date, set the optional additional_info query string parameter to true. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Additional info |
String |
Setting this parameter has no effect in this operation. |
||
String |
Setting this parameter has no effect in this operation. |
|||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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
Cloud Storage Get Cloud Storage Providers
<docusign:get-v21-accounts-users-cloud-storage-by-account-id-user-id>
Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/cloud_storage endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Redirect Url |
String |
The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Cloud Storage Get Cloud Storage
<docusign:get-v21-accounts-users-cloud-storage-by-account-id-user-id-service-id>
Retrieves the list of cloud storage providers enabled for the account and the configuration information for the user. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Service Id |
String |
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136"). |
x |
|
User Id |
String |
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, |
x |
|
Redirect Url |
String |
The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl. The redirectUrl is restricted to URLs in the docusign.com or docusign.net domains. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Cloud Storage Folder Get Cloud Storage Folder All
<docusign:get-v21-accounts-users-cloud-storage-folders-by-account-id-user-id-service-id>
Retrieves a list of all the items in a specified folder from the specified cloud storage provider. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Service Id |
String |
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136"). |
x |
|
User Id |
String |
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, |
x |
|
count |
String |
An optional value that sets how many items are included in the response. The default setting for this is 25. |
||
Search text |
String |
Use this parameter to search for specific text. |
||
order |
String |
(Optional) The order in which to sort the results. Valid values are: * |
||
Order by |
String |
(Optional) The file attribute to use to sort the results. Valid values are: * |
||
Start position |
String |
Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0. |
||
Cloud storage folder path |
String |
A comma-separated list of folder IDs included in the request. |
||
Output Mime Type |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Cloud Storage Folder Get Cloud Storage Folder
<docusign:get-v21-accounts-users-cloud-storage-folders-by-account-id-user-id-service-id-folder-id>
Retrieves a list of the user’s items from the specified cloud storage provider. To limit the scope of the items returned, provide a comma-separated list of folder ids in the request. This operation makes an HTTP GET request to the /v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Folder Id |
String |
The ID of the folder. |
x |
|
Service Id |
String |
The ID of the service to access. Valid values are the service name ("Box") or the numerical serviceId ("4136"). |
x |
|
User Id |
String |
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, |
x |
|
count |
String |
An optional value that sets how many items are included in the response. The default setting for this is 25. |
||
Search text |
String |
Use this parameter to search for specific text. |
||
order |
String |
(Optional) The order in which to sort the results. Valid values are: * |
||
Order by |
String |
(Optional) The file attribute to use to sort the results. Valid values are: * |
||
Cloud storage folderid plain |
String |
A plain-text folder ID that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter multiple folder ids as a comma-separated list. |
||
Start position |
String |
The starting index position in the result set from which to start returning values. The default setting is |
||
Cloud storage folder path |
String |
The file path to a cloud storage folder. |
||
Output Mime Type |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
encoding |
String |
Reserved for DocuSign. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Stamp type |
String |
The type of stamps to return. Valid values are: - |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
User Id |
String |
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, |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Image Type |
String |
Specificies the type of image. Valid values are: - |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
User Id |
String |
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, |
x |
|
Include chrome |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Workspace Id |
String |
The ID of the workspace. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Folder Id |
String |
The ID of the folder. |
x |
|
Workspace Id |
String |
The ID of the workspace. |
x |
|
count |
String |
The maximum number of results to return. |
||
Include thumbnails |
String |
When set to true, the response returns thumbnails. The default is false. |
||
Include user detail |
String |
When set to true, the response includes extended details about the user. The default is false. |
||
Include sub folders |
String |
When set to true, the response includes information about the sub-folders of the current folder. The default is false. |
||
Include files |
String |
When set to true, the response includes file information (in addition to folder information). The default is false. |
||
Start position |
String |
The position within the total result set from which to start returning values. |
||
Workspace user ID |
String |
If set, the response only includes results associated with the |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
File Id |
String |
The ID of the file. |
x |
|
Folder Id |
String |
The ID of the folder. |
x |
|
Workspace Id |
String |
The ID of the workspace. |
x |
|
Is download |
String |
When set to true, the |
||
Pdf version |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
File Id |
String |
The ID of the file. |
x |
|
Folder Id |
String |
The ID of the folder. |
x |
|
Workspace Id |
String |
The ID of the workspace. |
x |
|
Max width |
String |
Sets the maximum width of the returned images in pixels. |
||
count |
String |
The maximum number of results to return. |
||
Max height |
String |
Sets the maximum height of the returned images in pixels. |
||
dpi |
String |
The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94. |
||
Start position |
String |
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 |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Billing Plan Id |
String |
The ID of the billing plan being accessed. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Include jurisdictions |
String |
If true, the response will include a |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
count |
String |
The maximum number of results to return. |
||
Search text |
String |
Use this parameter to search for specific text. |
||
Start position |
String |
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 |
String |
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 |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
jurisdictionIdmust 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 |
String |
The name of the configuration to use. |
x |
|
Jurisdiction Id |
String |
The ID of the jurisdiction. The following jurisdictions are supported: - |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
encoding |
String |
Reserved for DocuSign. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Request Log Id |
String |
Request Log Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
Name of the configuration to use |
x |
|
Resource Owner Id |
String |
ID of the resource owner which access should be invalidated |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Preview billing plan |
String |
When set to true, updates the account using a preview billing plan. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Brand Id |
String |
The ID of the brand. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Brand Id |
String |
The ID of the brand. |
x |
|
Logo Type |
String |
The type of logo. Valid values are: - |
x |
|
Body |
String |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Brand Id |
String |
The ID of the brand. |
x |
|
Resource Content Type |
String |
The type of brand resource file that you are updating. Valid values are: - |
x |
|
File Xml - Body |
String |
The content of the 'fileXml' part. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Bulk Send List Id |
String |
The GUID of the bulk send list. This property is created after you post a new bulk send list. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
(Required) The external account number (int) or account ID GUID. |
x |
|
Chunked Upload Id |
String |
(Required) The ID of the chunked upload to commit. |
x |
|
action |
String |
(Required) You must use this query parameter with the value |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Chunked Upload Id |
String |
The ID of the chunked upload. |
x |
|
Chunked Upload Part Seq |
String |
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 |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 whencustomis set to false. The API returns a 200 OK HTTP response, but does not update theesignText. -
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Lang Code |
String |
(Optional) The code for the signer language version of the disclosure that you want to update. The following languages are supported: - Arabic ( |
x |
|
Include metadata |
String |
(Optional) When set to true, the response includes metadata indicating which properties are editable. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Custom Field Id |
String |
The ID of the custom field. |
x |
|
Apply to templates |
String |
Apply to templates |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Attachment Id |
String |
The unique identifier for the attachment. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Advanced update |
String |
When set to true, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes. |
||
Resend envelope |
String |
When set to true, sends the specified envelope again. |
||
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Page Number |
String |
The page number being accessed. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 -
email -
emailNotification -
idCheckConfigurationName -
name -
note -
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Combine same order recipients |
String |
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 |
String |
Indicates if offline signing is enabled for the recipient when a network connection is unavailable. |
||
Resend envelope |
String |
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. |
||
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
|---|---|
|
a valid UTC DateTime: |
|
A comma-separated list of envelope IDs or the special value |
|
A comma-separated list of transaction IDs or the special value |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
count |
String |
The maximum number of results to return. |
||
From to status |
String |
The envelope status that you are checking for. Possible values are: - |
||
String |
The email address of the sender. |
|||
Ac status |
String |
Specifies the Authoritative Copy Status for the envelopes. The possible values are: - |
||
Envelope ids |
String |
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 |
||
block |
String |
If set to true, removes any results that match one of the provided |
||
status |
String |
A comma-separated list of envelope status to search for. Possible values are: - |
||
From date |
String |
The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters |
||
User name |
String |
Limits results to envelopes sent by the account user with this user name. |
||
Start position |
String |
The starting index position for search. |
||
Transaction ids |
String |
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 |
||
To date |
String |
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. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Transfer Rule Id |
String |
The ID of the envelope transfer rule. The system generates this ID when the rule is first created. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Envelope Id |
String |
The envelope’s GUID. Example: |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Folder Id |
String |
The ID of the folder. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Group Id |
String |
The ID of the group being accessed. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Group Id |
String |
The ID of the group being accessed. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Permission Profile Id |
String |
The ID of the permission profile. Possible values include: - |
x |
|
include |
String |
A comma-separated list of additional properties to return in the response. The only valid value for this request is |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Power Forms Put Power Form
<docusign:update-v21-accounts-powerforms-by-account-id-power-form-id>
This method updates an existing PowerForm. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/powerforms/{powerFormId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Power Form Id |
String |
The ID of the PowerForm. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Put Report In Product Save
<docusign:update-v21-accounts-reports-by-account-id-id>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/reports/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
ID |
String |
A unique ID for the Salesforce object. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Put Report In Product Run Results
<docusign:update-v21-accounts-reports-report-results-by-account-id>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/reports/report_results endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Reports In Product Put Report Results Csv
<docusign:update-v21-accounts-reports-report-results-csv-by-account-id>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/reports/report_results_csv endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Settings Put Settings
<docusign:update-v21-accounts-settings-by-account-id>
Updates the account settings for the specified account. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/settings endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
ENote Configuration Put ENote Configuration
<docusign:update-v21-accounts-settings-enote-configuration-by-account-id>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/settings/enote_configuration endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Purge Configuration Put Envelope Purge Configuration
<docusign:update-v21-accounts-settings-envelope-purge-configuration-by-account-id>
An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays). This method sets the envelope purge configuration for your account.
Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/settings/envelope_purge_configuration endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Defaults Put Notification Defaults
<docusign:update-v21-accounts-settings-notification-defaults-by-account-id>
This method changes the default settings for the email notifications that signers and senders receive about envelopes. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/settings/notification_defaults endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Password Rules Put Account Password Rules
<docusign:update-v21-accounts-settings-password-rules-by-account-id>
This method updates the password rules for an account.
Note: To update the password rules for an account, you must be an account administrator.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/settings/password_rules endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Tab Settings Put Settings
<docusign:update-v21-accounts-settings-tabs-by-account-id>
This method modifies the tab types and tab functionality that is enabled for an account. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/settings/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Shared Access Put Shared Access
<docusign:update-v21-accounts-shared-access-by-account-id>
This sets the shared access status for one or more users or templates. When setting user shared access, only users with account administration privileges can set shared access status for envelopes. When setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates. Changes to the shared items status are not additive. The change always replaces the current status.
To change template shared access, add the query parameter item_type = templates to the request. When this is set, the user and envelopes properties are not required.
Note: This functionality is a newer version of the Update Group Share functionality.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/shared_access endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Item type |
String |
Specifies the type of shared item being set: - |
||
Preserve existing shared access |
String |
When true, preserve the existing shared access settings. |
||
User ids |
String |
A comma-separated list of IDs for users whose shared item access is being set. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Put Account Signature
<docusign:update-v21-accounts-signatures-by-account-id>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/signatures endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Put Account Signature By Id
<docusign:update-v21-accounts-signatures-by-account-id-signature-id>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/signatures/{signatureId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
Close existing signature |
String |
When set to true, closes the current signature. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Account Signatures Put Account Signature Image
<docusign:update-v21-accounts-signatures-by-account-id-signature-id-image-type>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/signatures/{signatureId}/{imageType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Image Type |
String |
Specificies the type of image. Valid values are: - |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
Transparent png |
String |
Transparent png |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Put Signing Groups
<docusign:update-v21-accounts-signing-groups-by-account-id>
Updates the name of one or more existing signing groups. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/signing_groups endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Put Signing Group
<docusign:update-v21-accounts-signing-groups-by-account-id-signing-group-id>
Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/signing_groups/{signingGroupId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signing Group Id |
String |
Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Signing Groups Put Signing Group Users
<docusign:update-v21-accounts-signing-groups-users-by-account-id-signing-group-id>
Adds one or more new members to a signing group. A signing group can have a maximum of 50 members. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/signing_groups/{signingGroupId}/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signing Group Id |
String |
Optional. The ID of the [signing group](https://support.docusign.com/en/guides/ndse-user-guide-signing-groups). Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, DocuSign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Tab Put Custom Tab
<docusign:update-v21-accounts-tab-definitions-by-account-id-custom-tab-id>
Updates the information in a custom tab for the specified account. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/tab_definitions/{customTabId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Custom Tab Id |
String |
The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Put Template
<docusign:update-v21-accounts-templates-by-account-id-template-id>
Updates an existing template. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Templates Put Template Part
<docusign:update-v21-accounts-templates-by-account-id-template-id-template-part>
Shares a template with the specified members group.
Note: For a newer version of this functionality, see Accounts::Update Shared Access.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/{templatePart} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Template Part |
String |
Currently, the only defined part is groups. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Custom Fields
<docusign:update-v21-accounts-templates-custom-fields-by-account-id-template-id>
Updates the custom fields in a template. Each custom field used in a template must have a unique name. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Documents
<docusign:update-v21-accounts-templates-documents-by-account-id-template-id>
Adds one or more documents to an existing template document. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Document
<docusign:update-v21-accounts-templates-documents-by-account-id-template-id-document-id>
This method updates an existing template document. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Is envelope definition |
String |
Is envelope definition |
||
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Document Fields
<docusign:update-v21-accounts-templates-documents-fields-by-account-id-template-id-document-id>
Updates existing custom document fields in an existing template document. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Page Image
<docusign:update-v21-accounts-templates-documents-pages-page-image-by-account-id-template-id-document-id-page-number>
Rotates page image from a template 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}/templates/{templateId}/documents/{documentId}/pages/{pageNumber}/page_image endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Page Number |
String |
The page number being accessed. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Document Tabs
<docusign:update-v21-accounts-templates-documents-tabs-by-account-id-template-id-document-id>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Document Id |
String |
The |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Lock
<docusign:update-v21-accounts-templates-lock-by-account-id-template-id>
This method updates the lock duration time or the lockedByApp property information for the specified template. The user and integrator key must match the user specified by the lockByUser property and 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}/templates/{templateId}/lock endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Templates Template Id Notification
<docusign:update-v21-accounts-templates-notification-by-account-id-template-id>
Updates the notification structure for an existing template. Use this endpoint to set reminder and expiration notifications. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/notification endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Bulk Recipients
<docusign:update-v21-accounts-templates-recipients-bulk-recipients-by-account-id-template-id-recipient-id>
Updates the bulk recipients in a template using a file upload. The Content-Type supported for uploading a bulk recipient file is CSV (text/csv). The REST API does not support modifying individual rows or values in the bulk recipients file. It only allows the entire file to be added or replaced with a new file.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Recipients
<docusign:update-v21-accounts-templates-recipients-by-account-id-template-id>
Updates recipients in a template. You can edit the following properties: email, userName, routingOrder, faxNumber, deliveryMethod, accessCode, and requireIdLookup.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Resend envelope |
String |
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. |
||
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Recipients Document Visibility
<docusign:update-v21-accounts-templates-recipients-document-visibility-by-account-id-template-id>
This method updates document visibility for one or more template recipients based on the recipientId and visible values that you include in the request body.
Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/document_visibility endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Recipient Document Visibility
<docusign:update-v21-accounts-templates-recipients-document-visibility-by-account-id-template-id-recipient-id>
This method updates the document visibility for a template recipient.
Note: A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Recipient Tabs
<docusign:update-v21-accounts-templates-recipients-tabs-by-account-id-template-id-recipient-id>
Updates one or more tabs for a recipient in a template. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Recipient Id |
String |
A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Template Workflow Definition
<docusign:update-v21-accounts-templates-workflow-by-account-id-template-id>
Updates the specified template''s workflow definition if it has one. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/templates/{templateId}/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Template Id |
String |
The ID of the template. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
DOCUSIGN:BAD_REQUEST
-
DOCUSIGN:CLIENT_ERROR
-
DOCUSIGN:CONNECTIVITY
-
DOCUSIGN:INTERNAL_SERVER_ERROR
-
DOCUSIGN:NOT_ACCEPTABLE
-
DOCUSIGN:NOT_FOUND
-
DOCUSIGN:RETRY_EXHAUSTED
-
DOCUSIGN:SERVER_ERROR
-
DOCUSIGN:SERVICE_UNAVAILABLE
-
DOCUSIGN:TIMEOUT
-
DOCUSIGN:TOO_MANY_REQUESTS
-
DOCUSIGN:UNAUTHORIZED
-
DOCUSIGN:UNSUPPORTED_MEDIA_TYPE
Users Put Users
<docusign:update-v21-accounts-users-by-account-id>
This method updates the information about one or more account users. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put User
<docusign:update-v21-accounts-users-by-account-id-user-id>
To update user information for a specific user, submit a [Users](#Users) object with updated field values in the request body of this operation. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/users/{userId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Custom Settings Put Custom Settings
<docusign:update-v21-accounts-users-custom-settings-by-account-id-user-id>
Adds or updates custom user settings for the specified user.
*Note: Custom user settings are not the same as user account settings. Custom settings provide a flexible way to store and retrieve custom user information that you can use in your own system.
Important: There is a limit on the size for all the custom user settings for a single user. The limit is 4,000 characters, which includes the XML and JSON structure for the settings.
Grouping Custom User Settings
You can group custom user settings when adding them. Grouping allows you to retrieve settings that are in a specific group, instead of retrieving all the user custom settings. To group custom user settings, add the following information in the header, after Content-Type: X-DocuSign-User-Settings-Key:group_name, where the group_name is your designated name for the group of customer user settings.
When getting or deleting grouped custom user settings, you must include the extra header information. Grouping custom user settings is not required and if the extra header information is not included, the custom user settings are added normally and can be retrieved or deleted without including the additional header.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/users/{userId}/custom_settings endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put Profile
<docusign:update-v21-accounts-users-profile-by-account-id-user-id>
Updates the user’s detail information, profile information, privacy settings, and personal information in the user ID card. You can also change a user’s name by changing the information in the userDetails property. When changing a user’s name, you can either change the information in the userName property OR change the information in firstName, middleName, lastName, suffixName, and title properties. Changes to firstName, middleName, lastName, suffixName, and title properties take precedence over changes to the userName property.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/users/{userId}/profile endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put User Profile Image
<docusign:update-v21-accounts-users-profile-image-by-account-id-user-id>
Updates the user profile image by uploading an image to the user profile. The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, DocuSign recommends that the image is no more than 79 pixels wide and high.
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/users/{userId}/profile/image endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put User Settings
<docusign:update-v21-accounts-users-settings-by-account-id-user-id>
Updates the account settings list and email notification types for the specified user. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/users/{userId}/settings endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put User Signature
<docusign:update-v21-accounts-users-signatures-by-account-id-user-id>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/users/{userId}/signatures endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
User Id |
String |
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, |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put User Signature By Id
<docusign:update-v21-accounts-users-signatures-by-account-id-user-id-signature-id>
Creates, or updates, the signature font and initials for the specified user. When creating a signature, you use this resource to create the signature name and then add the signature and initials images into the signature.
Note: This will also create a default signature for the user when one does not exist.
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. 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 PUT request to the /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
User Id |
String |
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, |
x |
|
Close existing signature |
String |
When set to true, closes the current signature. |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put User Signature Image
<docusign:update-v21-accounts-users-signatures-by-account-id-user-id-signature-id-image-type>
Updates the user signature image or user initials image for the specified user. The supported image formats for this file are: gif, png, jpeg, and bmp. The file must be less than 200K.
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".
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/users/{userId}/signatures/{signatureId}/{imageType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Image Type |
String |
Specificies the type of image. Valid values are: - |
x |
|
Signature Id |
String |
The ID of the signature being accessed. |
x |
|
User Id |
String |
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, |
x |
|
Transparent png |
String |
Transparent png |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put Watermark
<docusign:update-v21-accounts-watermark-by-account-id>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/watermark endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Preview Put Watermark Preview
<docusign:update-v21-accounts-watermark-preview-by-account-id>
This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/watermark/preview endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put Workspace
<docusign:update-v21-accounts-workspaces-by-account-id-workspace-id>
Updates information about a specific workspace. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/workspaces/{workspaceId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
Workspace Id |
String |
The ID of the workspace. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put Workspace File
<docusign:update-v21-accounts-workspaces-folders-files-by-account-id-workspace-id-folder-id-file-id>
This method updates the metadata for one or more specific files or folders in a workspace. This operation makes an HTTP PUT request to the /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/{folderId}/files/{fileId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The external account number (int) or account ID GUID. |
x |
|
File Id |
String |
The ID of the file. |
x |
|
Folder Id |
String |
The ID of the folder. |
x |
|
Workspace Id |
String |
The ID of the workspace. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put Notary
<docusign:update-v21-current-user-notary>
Updates notary information for the current user. This operation makes an HTTP PUT request to the /v2.1/current_user/notary endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put Notary Jurisdiction
<docusign:update-v21-current-user-notary-jurisdictions-by-jurisdiction-id>
Updates the jurisdiction information about a notary. The following restrictions apply:
-
The current user must be a notary.
-
The
jurisdictionIdpath parameter must be a jurisdiction that the notary is registered for. -
The
jurisdictionIdpath parameter must match the request body’sjurisdiction.jurisdictionId.
The request body must have a full jurisdiction object for the jurisdiction property. The best way to do this is to use getNotaryJurisdiction to obtain the current values and update the properties you want to change. For example, assume getNotaryJurisdiction returns this:
{
"jurisdiction": {
"jurisdictionId": "15",
"name": "Iowa",
"county": "",
"enabled": "true",
"countyInSeal": "false",
"commissionIdInSeal": "true",
"stateNameInSeal": "true",
"notaryPublicInSeal": "true",
"allowSystemCreatedSeal": "true",
"allowUserUploadedSeal": "false"
},
"commissionId": "123456",
"commissionExpiration": "2020-08-31T07:00:00.0000000Z",
"registeredName": "Bob Notary",
"county": "Adams",
"sealType": "system_created"
}If you want to change the name of the notary from "Bob Notary" to "Robert Notary", your request body would be:
{
"jurisdiction": {
"jurisdictionId": "15",
"name": "Iowa",
"county": "",
"enabled": "true",
"countyInSeal": "false",
"commissionIdInSeal": "true",
"stateNameInSeal": "true",
"notaryPublicInSeal": "true",
"allowSystemCreatedSeal": "true",
"allowUserUploadedSeal": "false"
},
"commissionId": "123456",
"commissionExpiration": "2020-08-31T07:00:00.0000000Z",
"registeredName": "Robert Notary",
"county": "Adams",
"sealType": "system_created"
}This operation makes an HTTP PUT request to the /v2.1/current_user/notary/jurisdictions/{jurisdictionId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Jurisdiction Id |
String |
The ID of the jurisdiction. The following jurisdictions are supported: - |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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 Put Request Log Settings
<docusign:update-v21-diagnostics-settings>
Enables or disables API request logging for troubleshooting. When enabled (apiRequestLogging is true), REST API requests and responses for the user are added to a log. A log can have up to 50 requests/responses and the current number of log entries can be determined by getting the settings. Logging is automatically disabled when the log limit of 50 is reached.
You can call Diagnostics::getRequestLog or Diagnostics::listRequestLogs to download the log files (individually or as a zip file). Call Diagnostics::deleteRequestLogs to clear the log by deleting current entries.
Private information, such as passwords and integrator key information, which is normally located in the call header is omitted from the request/response log. API request logging only captures requests from the authenticated user. Any call that does not authenticate the user and resolve a userId is not logged.
This operation makes an HTTP PUT request to the /v2.1/diagnostics/settings endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for the request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
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 |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
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
Types
Proxy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Host |
String |
x |
||
Port |
Number |
x |
||
Username |
String |
|||
Password |
String |
|||
Non Proxy Hosts |
String |
TLS
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible. |
||
Password |
String |
Password used to protect the truststore. |
||
Type |
String |
Type of truststore used. |
||
Algorithm |
String |
Algorithm used by the truststore. |
||
Insecure |
Boolean |
If |
Key Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible. |
||
Type |
String |
Type of keystore used. |
||
Alias |
String |
When the keystore contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
Password used to protect the private key. |
||
Password |
String |
Password used to protect the keystore. |
||
Algorithm |
String |
Algorithm used by the keystore. |
Standard Revocation Check
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom OCSP Responder
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Reconnection
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment |
Boolean |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
||
Reconnection Strategy |
The reconnection strategy to use. |
Reconnect
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
||
Count |
Number |
How many reconnection attempts to make. |
Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute |
HTTP Response Attributes
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Status Code |
Number |
x |
||
Headers |
Object |
x |
||
Reason Phrase |
String |
x |
Repeatable In Memory Stream
Configures the in-memory streaming strategy. With this strategy, the request fails if the data exceeds the buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment value, with an upper limit of the Max In Memory Size value. |
||
Buffer Size Increment |
Number |
Amount by which the buffer size expands if it exceeds its initial size. Setting a value of |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
Size unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields. |
Repeatable File Store Stream
Configures the repeatable file-store streaming strategy. With this strategy, Mule keeps a portion of the stream data in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Non-repeatable Stream
Disables the repeatable stream functionality and uses non-repeatable streams to have less performance overhead, memory use, and cost.
Redelivery Policy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Redelivery Count |
Number |
The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message |
||
Message Digest Algorithm |
String |
The secure hashing algorithm to use. If not set, the default is SHA-256. |
||
Message Identifier |
Defines which strategy is used to identify the messages. |
|||
Object Store |
ObjectStore |
The object store where the redelivery counter for each message is stored. |
Redelivery Policy Message Identifier
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Use Secure Hash |
Boolean |
Whether to use a secure hash algorithm to identify a redelivered message. |
||
Id Expression |
String |
Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false. |
Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects |
Number |
The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |