Docusign Connector 1.0 Reference

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.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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

Connection Timeout

Number

Timeout for establishing connections to the remote service

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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.

https://www.docusign.net/restapi

Authorization

String

Authorization

TLS Configuration

TLS

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)

Parameters

Name Type Description Default Value Required

Default Headers

Array of Default Header

Query Parameters

Connection Timeout

Number

Timeout for establishing connections to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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.

https://www.docusign.net/restapi

TLS Configuration

TLS

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.

https://account-d.docusign.com/oauth/auth

Access Token Url

String

Service provider’s access token endpoint URL.

https://account-d.docusign.com/oauth/token

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

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

Output

Type

Any

Attributes Type

For Configurations

Operations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Specifies how the connector streams request content to the remote service:

  • AUTO (default)

    Connector automatically uses the best streaming strategy based on the request content.

  • ALWAYS

    Connector always streams the request content.

  • NEVER

    Connector does not stream the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Billing Payments Post Payment

<docusign:create-v21-accounts-billing-payments-by-account-id>

Posts a payment to a past due invoice. This method can only be used if the paymentAllowed value for a past due invoice is true. This can be determined calling Billing::listInvoicesPastDue. The response returns information for a single payment, if a payment ID was used in the endpoint, or a list of payments. If the from date or to date queries or payment ID are not used, the response returns payment information for the last 365 days. If the request was for a single payment ID, the nextUri and previousUri properties are not returned.

Privileges required: account administrator

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/billing_payments endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Brands Post Brands

<docusign:create-v21-accounts-brands-by-account-id>

This method creates one or more brand profile files for an account. If the brandId property for a brand profile is already set for the account, an error is returned. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version. When you upload brand profile files, you must combine them into a single zip file and set the Content-Type to application/zip.

Note: Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/brands endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Bulk Send V2CRUD Post Bulk Send List

<docusign:create-v21-accounts-bulk-send-lists-by-account-id>

Creates a bulk send list that you can use to send an envelope to up to 1,000 recipients concurrently. It returns the following errors:

Error code Description

BULK_SEND_MAX_COPIES_EXCEEDED

A bulk sending list cannot specify more than XXX copies in the mailing list. Call the settings API endpoint to find the maximum number of copies in a batch allowed for your account. In almost all cases, the default limit is 1000.

BULK_SEND_RECIPIENT_IDS_MUST_BE_UNIQUE

No two recipientIds can be same within a bulkCopy. Same restriction as a regular envelope applies. Specify unique recipient IDs for each recipient within a bulkCopy (model for envelope in mailing list).

BULK_SEND_RECIPIENT_ID_REQUIRED

If no RoleName is present, recipientID is required in mailing list’s bulkCopy. Add a roleName (that coalesces with template/envelope) or a recipientID.

BULK_SEND_RECIPIENT_NAME_REQUIRED

Recipient {0} has no name. Specify a name for the recipient.

BULK_SEND_EMAIL_ADDRESS_REQUIRED_FOR_EMAIL_RECIPIENT

Recipient {0} is an email recipient with no email address. Specify an email for the email recipient.

BULK_SEND_FAX_NUMBER_REQUIRED_FOR_FAX_RECIPIENT

Recipient {0} is a fax recipient with no fax number. Specify a fax number for the fax recipient.

BULK_SEND_FAX_NUMBER_NOT_VALID

Recipient {0} specifies fax number {1}, which is not valid. Specify a valid fax number for the fax recipient.

BULK_SEND_EMAIL_ADDRESS_NOT_VALID

Recipient {0} specifies email address {1}, which is not a valid email address. Specify a valid email address for the recipient.

BULK_SEND_PHONE_NUMBER_REQURED_FOR_SMS_AUTH

Recipient {0} specifies SMS auth, but no number was provided. Specify a phone number for the SMS auth recipient.

BULK_SEND_PHONE_NUMBER_INVALID_FOR_SMS_AUTH

Recipient {0} specifies phone number {1} for SMS auth, which is not valid. Specify a valid phone number for the SMS auth recipient.

BULK_SEND_ROLE_NAMES_MUST_BE_UNIQUE

Recipient role names cannot be duplicated; role {duplicateRecipientRole} appears multiple times. Use unique roleNames for recipients.

BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_ON_SAME_RECIPIENT

Recipients cannot have both ID and Role; {0} has both. Specify a roleName or recipientId, but not both for the same recipient.

BULK_SEND_CANNOT_USE_BOTH_ROLE_AND_ID_IN_SAME_LIST

Cannot use both recipient role and ID in the same list. Specify a roleName or recipientId, but not both in the same list.

BULK_SEND_INVALID_ID_CHECK_CONFIGURATION

Recipient {0} specified SMS authentication, but no SMS auth settings were provided. Provide an SMS auth setting (proper ID configuration) if SMS auth is specified.

BULK_SEND_INVALID_SBS_INPUT_CONFIGURATION

Recipient {0} has more than one signature provider specified. Or signingProviderName is not specified. Or Signature provider : {0} is either unknown or not an available pen for this account. One or more SBS configuration is missing or invalid. The error details provide specifics.

BULK_SEND_TAB_LABELS_MUST_BE_UNIQUE

Tab label {0} is duplicated. Needs to be unique. Use a unique tab label.

BULK_SEND_TAB_LABEL_REQUIRED

Tab label is required. Specify a tab label.

BULK_SEND_TAB_VALUE_REQUIRED

Tab Label value is required. Specify a value for the tab label.

BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_MUST_BE_UNIQUE

Custom fields must have distinct names. The field {0} appears more than once in a copy. Use unique names for custom fields.

BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_REQUIRED

All custom fields must have names. Specify a name for the custom field.

BULK_SEND_ENVELOPE_CUSTOM_FIELD_VALUE_REQUIRED

Custom field {0} has no value. A custom field can have an empty value, but it cannot have a null value. Specify a value for the custom field.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/bulk_send_lists endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Bulk Send V2Send Post Bulk Send Request

<docusign:create-v21-accounts-bulk-send-lists-send-by-account-id-bulk-send-list-id>

Initiates the bulk send process. It generates a bulk send request based on an existing bulk send list and an envelope or template. Consider using the [createBulkSendTestRequest] method to test your bulk send list for compatibility with the envelope or template that you want to send first. If the envelopes were successfully queued for asynchronous processing, the response contains a batchId that you can use to get the status of the batch. If a failure occurs, the API returns an error message.

Note: Partial success or failure generally does not occur. Only the entire batch is queued for asynchronous processing.

This method returns the following errors:

Error code Description

BULK_SEND_ENVELOPE_NOT_IN_SENDABLE_STATE

Envelope {0} is not in a sendable state. The envelope is not complete. Make sure it has a sendable status, such as created.

BULK_SEND_ENVELOPE_LIST_CONTAINS_NO_COPIES

Cannot send an envelope with a bulk sending list which contains no copies. The list you’re trying to bulk send is empty. Make sure the bulk sending list you’re using contains recipients.

BULK_SEND_ENVELOPE_LIST_CONTAINS_TOO_MANY_COPIES

Bulk sending list contains more than {0} copies. The list you’re trying to bulk send will cause your account to exceed the 1,000-copy limit imposed for all accounts. Try sending two or more separate lists.

BULK_SEND_ENVELOPE_CANNOT_BE_NULL

Cannot send a bulk list without an envelope. Specify the envelope ID or template ID for the envelope you want to bulk send.

BULK_SEND_BLOB_STORE_ERROR

Could not save copy of bulk sending list. An error writing to the database occurred. Try again. If the error persists, contact DocuSign Support.

BULK_SEND_ACCOUNT_HAS_TOO_MANY_QUEUED_ENVELOPES

Cannot send this bulk sending list because doing so would exceed the maximum of {maxCopies} in-flight envelopes. This account currently has {unprocessedEnvelopes} envelopes waiting to be processed. Please try again later." .Try again later, or contact DocuSign Support to request a higher tier.

BULK_SEND_ENVELOPE_NOT_FOUND

Envelope {envelopeOrTemplateId} does not exist or you do not have permission to access it. The envelopeId or templateId specified could not be found. Specify a valid value.

BULK_SEND_LIST_NOT_FOUND

Bulk Sending list {listId} does not exist or you do not have permission to access it. The mailingListId specified could not be found. Specify a valid value.

BULK_SEND_ENVELOPE_HAS_NO_RECIPIENTS

Bulk sending copy contains recipients, but the specified envelope does not. The recipients on the envelope and the bulk send list do not match. Make sure the envelope and list are compatible for sending.

BULK_SEND_RECIPIENT_ID_DOES_NOT_EXIST_IN_ENVELOPE

Recipient {0} does not exist in the envelope. Add the missing recipient to the envelope.

BULK_SEND_RECIPIENT_ID_DOES_NOT_MATCH

Recipient ID {envelopeMember.ID} does not match. Make sure the recipient information in the list and the envelope match up.

BULK_SEND_ENVELOPE_HAS_BULK_RECIPIENT

Recipient {0} is a bulk recipient. This is not supported. No legacy 'bulk recipient' allowed. In v2.1 of the eSignature API, you must use a bulk send list instead of a bulk recipient. See the API documentation for details.

BULK_SEND_RECIPIENT_ROLE_DOES_NOT_MATCH

Recipient Role {envelopeMember.RoleName} does not match. Make sure the recipient information in the list and the envelope is compatible.

BULK_SEND_DUPLICATE_RECIPIENT_DETECTED

Duplicate recipients ({0}) not allowed, unless recipients have unique routing order specified on envelope.

BULK_SEND_ENVELOPE_HAS_NO_TABS

Bulk sending copy contains tabs, but the specified envelope does not. List and envelope tabs cannot be coalesced. Make sure they are compatible for sending.

BULK_SEND_TAB_LABEL_DOES_NOT_EXIST_IN_ENVELOPE

Tab with label {0} does not exist in envelope. Add the tab label to the envelope, remove the label from the list, or make sure you’re specifying the correct list and envelope.

BULK_SEND_TAB_DOES_NOT_MATCH

Tab {0} does not match {0} in envelope. A tab exists on the list that does not match or is missing on the envelope. Make sure the tabs on the list and the envelope match.

BULK_SEND_ENVELOPE_HAS_NO_ENVELOPE_CUSTOM_FIELDS

Bulk sending copy contains custom fields, but the specified envelope does not. There are custom fields on the list that the envelope does not have. Make sure that any custom fields on the list and the envelope match.

BULK_SEND_ENVELOPE_CUSTOM_FIELD_DOES_NOT_EXIST_IN_ENVELOPE

Custom field {0} does not exist in the envelope. Either add the custom field on the list to the envelope, remove the custom field from the list, or make sure you’re specifying the correct list and envelope.

BULK_SEND_ENVELOPE_CUSTOM_FIELD_NAME_DOES_NOT_MATCH

Custom field names must match. {0} and {1} do not match. The custom field names on the list and the envelope do not match. Use identical names for both.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Bulk Send V2Test Post Bulk Send Test Request

<docusign:create-v21-accounts-bulk-send-lists-test-by-account-id-bulk-send-list-id>

This method tests a bulk send list for compatibility with the envelope or template that you want to send. For example, a template that has three roles is not compatible with a bulk send list that has only two recipients. For this reason, you might want to test compatibility first. A successful test result returns true for the canBeSent property. An unsuccessful test returns a JSON response that contains information about the errors that occurred. If the test is successful, you can then send the envelope or template by using the BulkSendRequest method.

Envelope Compatibility Checks

This section describes the envelope compatibility checks that the system performs.

Top-Level Issues

  • Envelopes must be in a sendable state.

    • The bulk send list must contain at least one copy (instance of an envelope), and no more than the maximum number of copies allowed for the account.

    • The envelope must not be null and must be visible to the current user.

    • The account cannot have more queued envelopes than the maximum number configured for the account.

    • The bulk send list must exist.

  • Recipients

    • The envelope must have recipients.

    • If you are using an envelope, all of the recipients defined in the bulk send list must have corresponding recipient IDs in the envelope definition. If you are using a template, you must either match the recipient IDs or role IDs.

    • The envelope cannot contain a bulk recipient (an artifact of the legacy version of DocuSign’s bulk send functionality).

  • Recipient Tabs

    • Every recipient ID, tab label pair in the bulk send list must correspond to a tab in the envelope.

  • Custom Fields

    • Each envelope-level custom field in the bulk send list must correspond to the name of a customField in the envelope definition. You do not have to match the recipient-level custom fields.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Chunked Uploads Post Chunked Uploads

<docusign:create-v21-accounts-chunked-uploads-by-account-id>

This method initiates a new chunked upload with the first part of the content. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/chunked_uploads endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Connect Post Connect Configuration

<docusign:create-v21-accounts-connect-by-account-id>

Creates a DocuSign Custom Connect definition for your account. DocuSign Connect enables the sending of real-time data updates to external applications. These updates are generated by user transactions as the envelope progresses through actions to completion. The Connect Service provides updated information about the status of these transactions and returns updates that include the actual content of document form fields. These updates might or might not include the document itself.

Note: Connect must be enabled for your account to use this function. This cannot be used to set up Connect configurations for Salesforce or eOriginal.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/connect endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Contacts Post Contacts

<docusign:create-v21-accounts-contacts-by-account-id>

This method imports multiple new contacts into a contact list from a CSV, JSON, or XML file. To use this method, you must provide a request body in one of the supported formats and include a content-type header with the appropriate value. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/contacts endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Account Custom Fields Post Account Custom Fields

<docusign:create-v21-accounts-custom-fields-by-account-id>

This method creates a custom field and makes it available for all new envelopes associated with an account. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/custom_fields endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Envelopes Post Envelopes

<docusign:create-v21-accounts-envelopes-by-account-id>

Creates and sends an envelope or creates a draft envelope. Envelopes are fundamental resources in the DocuSign platform. With this method you can:

  • Create and send an envelope with documents, recipients, and tabs.

  • Create and send an envelope from a template.

  • Create and send an envelope from a combination of documents and templates.

  • Create a draft envelope.

When you use this method to create and send an envelope in a single request, the following parameters in the request body are required:

Parameter Description

status

Set to sent to send the envelope to recipients. Set to created (or don’t set at all) to save the envelope as a draft.

emailSubject

The subject of the email used to send the envelope.

documents

The [documents][] to be signed.

recipients

The email addresses of the envelope recipients.

Note: If the envelope has a workflow definition and the workflowStatus is paused, the envelope will not be sent immediately, even if the envelope’s status is sent. There are many ways to use envelopes. You can create and send an envelope with a single API request, or you can use several API requests to create, populate, and send envelopes.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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 status field is set to created.) Note: DocuSign recommends that this parameter should be set to true whenever you create a draft envelope with multiple templates.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Custom Fields Post Custom Fields

<docusign:create-v21-accounts-envelopes-custom-fields-by-account-id-envelope-id>

Updates the envelope custom fields for draft and in-process envelopes. You may assign up to three envelope custom fields to an envelope. This limit does not include account (document) custom fields. Each custom field used in an envelope must have a unique name. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/custom_fields endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Document Fields Post Document Fields

<docusign:create-v21-accounts-envelopes-documents-fields-by-account-id-envelope-id-document-id>

Creates custom document fields in an existing envelope document. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/fields endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

x

Envelope Id

String

The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Responsive Html Post Document Responsive Html Preview

<docusign:create-v21-accounts-envelopes-documents-responsive-html-preview-by-account-id-envelope-id-document-id>

Creates a preview of the responsive HTML version of a specific document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/responsive_html_preview endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

x

Envelope Id

String

The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Tabs Post Document Tabs

<docusign:create-v21-accounts-envelopes-documents-tabs-by-account-id-envelope-id-document-id>

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

x

Envelope Id

String

The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Templates Post Document Templates

<docusign:create-v21-accounts-envelopes-documents-templates-by-account-id-envelope-id-document-id>

Adds templates to a document in the specified envelope. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/templates endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

x

Envelope Id

String

The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Email Settings Post Email Settings

<docusign:create-v21-accounts-envelopes-email-settings-by-account-id-envelope-id>

Adds email override settings, changing the email address to reply to an email address, name, or the BCC for email archive information, for the envelope. Note that adding email settings will only affect email communications that occur after the addition was made.

The BCC Email address feature is designed to provide a copy of all email communications for external archiving purposes. DocuSign recommends that envelopes sent using the BCC for Email Archive feature, including the BCC Email Override option, include additional signer authentication options. To send a copy of the envelope to a recipient who does not need to sign, use a Carbon Copy or Certified Delivery recipient type.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Lock Post Envelope Lock

<docusign:create-v21-accounts-envelopes-lock-by-account-id-envelope-id>

This method locks the specified envelope and sets the time until the lock expires to prevent other users or recipients from changing the envelope. The response to this request returns a lockToken parameter. You must use the lockToken to update or delete an existing lock. You must also include the lockToken in the header for every PUT call that you make on the envelope while it is locked. If you do not include the lockToken, the system returns the following error:

{ "errorCode": "EDIT_LOCK_NOT_LOCK_OWNER", "message": "The user is not the owner of the lock. The template is locked by another user or in another application" }

Note: Users must have envelope locking capability enabled to use this function (userSetting canLockEnvelopes must be set to true for the user).

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/lock endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Recipients Post Recipients

<docusign:create-v21-accounts-envelopes-recipients-by-account-id-envelope-id>

Adds one or more recipients to an envelope. For an in process envelope, one that has been sent and has not been completed or voided, an email is sent to a new recipient when they are reached in the routing order. If the new recipient’s routing order is before or the same as the envelope’s next recipient, an email is only sent if the optional resend_envelope query string is set to true.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Recipients Post Recipient Proof File Resource Token

<docusign:create-v21-accounts-envelopes-recipients-identity-proof-token-by-account-id-envelope-id-recipient-id>

Creates a resource token for a sender. This token allows a sender to return identification data for a recipient using the ID Evidence API.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/identity_proof_token endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Account Id

String

The account ID.

x

Envelope Id

String

The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

x

Recipient Id

String

The recipientIdGuid.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Recipients Post Recipient Tabs

<docusign:create-v21-accounts-envelopes-recipients-tabs-by-account-id-envelope-id-recipient-id>

Adds one or more tabs for a recipient. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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 recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Responsive Html Post Responsive Html Preview

<docusign:create-v21-accounts-envelopes-responsive-html-preview-by-account-id-envelope-id>

Creates a preview of the responsive HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the documents. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Templates Post Envelope Templates

<docusign:create-v21-accounts-envelopes-templates-by-account-id-envelope-id>

Adds templates to the specified envelope. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/templates endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Envelope Transfer Rules Post Envelope Transfer Rules

<docusign:create-v21-accounts-envelopes-transfer-rules-by-account-id>

Creates an envelope transfer rule. When you create an envelope transfer rule, you specify the following properties:

  • eventType

  • fromGroups

  • 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Views Post Envelope Correct View

<docusign:create-v21-accounts-envelopes-views-correct-by-account-id-envelope-id>

Returns a URL that allows you to embed the envelope correction view of the DocuSign UI in your applications. Important: Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.

Note: You can revoke this URL by making the DELETE call to the same URL with no request body. Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access. If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:

  • Configure each sender to have their own individual user account to use this API method.

  • Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/correct endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Views Post Envelope Edit View

<docusign:create-v21-accounts-envelopes-views-edit-by-account-id-envelope-id>

Returns a URL that enables you to embed the edit view of the DocuSign UI in your applications. This is a one-time use login token that allows the user to be placed into the DocuSign editing view. Upon sending completion, the user is returned to the return URL provided by the API application.

Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.

You can revoke this URL by making the DELETE call to the same URL with no request body.

Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.

If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:

  • Configure each sender to have their own individual user account to use this API method.

  • Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Views Post Envelope Recipient View

<docusign:create-v21-accounts-envelopes-views-recipient-by-account-id-envelope-id>

Returns a URL that enables you to embed the recipient view of the DocuSign UI in your applications. If the recipient is a signer, then the view will provide the signing ceremony.

Note: Please redirect the client to the URL. iFrames should not be used, especially if the recipient is using a mobile or tablet. This method is only used with envelopes in the sent status. Your application is responsible for authenticating the identity of the recipient or signer when you use this method. Use the parameters assertionId, authenticationInstant, authenticationMethod, clientUserId, and securityDomain to record information on how the recipient was authenticated. At a minimum, authenticationMethod and clientUserId are required. The information that you provide is included in the envelope’s certificate of completion.

Redirects

After the signer completes or ends the signing ceremony, DocuSign will redirect the user’s browser back to your app via the returnUrl that you supply. (The user is redirected through a different subdomain, depending on the region of the account sending the envelope. Verify your domain allowlist.)

The event status parameter

DocuSign appends an event query parameter to the URL with the outcome of the signing ceremony. Your app can use this event parameter to determine the next step for the envelope. Do not fetch the envelope status by using Envelopes::get or a similar method because doing so could break the DocuSign rule against polling.

Note: Because a user can cancel redirection, close their browser after signing, or spoof the landing URL. Hitting the ReturnUrl should not be the single source of truth for envelope status for your integration.

The URL is time-limited

The URL returned by this method is valid for one use, and you must use or display it within a couple of minutes after it is generated. AFter the recipient is redirected to the recipient view, they must interact with the DocuSign system periodically or their session will time out. Because the URL is time-limited, it should not be stored or sent through email. After you receive it, immediately redirect the user’s browser to the URL. If you want to invite someone to an embedded signing session via email, the email invitation’s URL must be to your application. When invoked, your app should request a recipientView URL from DocuSign and then redirect the signer to that URL.

Maintaining State

After the recipient completes the recipient view (or signing ceremony), they are redirected to your application. Your application can recover state information about the transaction by storing information in a cookie, or by including query parameters in the returnUrl field, for example https://myapp.eg.com/docusign_return?myState=12345. When the user is redirected to your app, the event query parameter will be appended. In this example, prevent spoofing by not using a guessable value as the state value.

Note: You can revoke the URL by making the DELETE call to the same URL with no request body.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Views Post Envelope Recipient Preview

<docusign:create-v21-accounts-envelopes-views-recipient-preview-by-account-id-envelope-id>

This method returns a URL for an envelope recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Views Post Envelope Sender View

<docusign:create-v21-accounts-envelopes-views-sender-by-account-id-envelope-id>

Returns a URL that enables you to embed the sender view of the DocuSign UI in your applications. The returned URL can only be redirected to immediately after it is generated. It can only be used once. Therefore, request the URL immediately before you redirect your user to it.

For the best user experience, don’t use an iFrame. For iOS devices DocuSign recommends using a WebView. Multiple solutions are available for maintaining your client state. After the user has completed the sending view, the browser is redirected to the returnUrl supplied. By default, if the envelope already contains one or more documents, DocuSign will initially show the document tagging view when you redirect to the URL.

To start with the envelope’s recipients and documents view instead, examine the URL in the method’s response. Then change the query parameter from send=1 to send=0 to start with the recipients/documents view.

Note: You can revoke the URL by making the DELETE call to the same URL with no request body.

Information Security notice: This method provides full access to the sending account. When you use this view, the current user has full access to the account. If the account has administrative privileges, then this method also provides administrator access.

If your use case needs to enable a sender to update a draft envelope before it is sent or make other changes, take one of the following steps:

  • Configure each sender to have their own individual user account to use this API method.

  • Enhance your API integration so that this method is not needed. Your integration can create the tabs, recipients, and other envelope settings as needed.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/sender endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Views Post Envelope Recipient Shared View

<docusign:create-v21-accounts-envelopes-views-shared-by-account-id-envelope-id>

Returns a URL that enables you to embed the DocuSign UI recipient view of a shared envelope in your applications. The view that a user sees of an envelope that a recipient on the same account has shared with them.

Due to screen space issues, iFrames should not be used for embedded operations on mobile devices. For iOS devices, DocuSign recommends using a WebView.

You can revoke this URL by making the DELETE call to the same URL with no request body.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/shared endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Groups Post Groups

<docusign:create-v21-accounts-groups-by-account-id>

Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the userSettings property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/groups endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Permission Profiles Post Permission Profiles

<docusign:create-v21-accounts-permission-profiles-by-account-id>

This method creates a new permission profile for an account. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/permission_profiles endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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 metadata, which returns metadata indicating whether the properties associated with the account permission profile 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Power Forms Post Power Form

<docusign:create-v21-accounts-powerforms-by-account-id>

This method creates a new PowerForm. You create a PowerForm from an existing DocuSign template, based on the templateId in the request body. PowerForms that you create from a template are referred to as web PowerForms.

The RADmin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a PDF PowerForm). However, PDF PowerForms are deprecated and are not supported in the API.

A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm initiator.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm.

Signing modes

You can use one of the following signing modes for a PowerForm: 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Reports In Product Post Report In Product Create

<docusign:create-v21-accounts-reports-by-account-id>

Reports In Product Post Report In Product Create This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/reports endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

BCCEmail Archive Post BCCEmail Archive

<docusign:create-v21-accounts-settings-bcc-email-archives-by-account-id>

This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates). The only property that you must set in the request body is the BCC email address that you want to use.

Note: An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/settings/bcc_email_archives endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Account Signatures Post Account Signatures

<docusign:create-v21-accounts-signatures-by-account-id>

Account Signatures Post Account Signatures This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/signatures endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Signing Groups Post Signing Groups

<docusign:create-v21-accounts-signing-groups-by-account-id>

Creates one or more signing groups. Multiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. An account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members. Signing groups can be used by any account user. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/signing_groups endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Tabs Post Tab Definitions

<docusign:create-v21-accounts-tab-definitions-by-account-id>

Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/tab_definitions endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Templates Post Templates

<docusign:create-v21-accounts-templates-by-account-id>

Creates one or more template definitions, using a multipart request for each template. Templates help streamline the sending process when you frequently send the same or similar documents, or send different documents to the same group of people. When you create a template, you define placeholder roles. Rather than specifying a person, you specify a role that regularly participates in a transaction that uses the template. Then, when you create or send an envelope based on the template, you assign actual recipients to the template roles. The recipients automatically inherit all of the workflow that is defined for that role in the template, such as the tabs and routing information. For code examples and more information, see REST API Templates.

Template Email Subject Merge Fields

Placeholder roles have associated merge fields that personalize the email notification that DocuSign sends. For example, the template automatically personalizes the email message by adding placeholders for the recipient’s name and email address within the email subject line, based on the recipient’s role. When the sender adds the name and email information for the recipient and sends the envelope, the recipient information is automatically merged into the appropriate fields in the email subject line. Both the sender and the recipients will see the information in the email subject line for any emails associated with the template. This provides an easy way for senders to organize their envelope emails without having to open an envelope to find out who the recipient is.

If merging the recipient information into the subject line causes the subject line to exceed 100 characters, then any characters over the 100 character limit are not included in the subject line. For cases where you expect the recipient name or email to be long, you should consider placing the merge field at the start of the email subject.

To insert a recipient’s name into the subject line, add the following text in the emailSubject property when you create the template:

[[<roleName>_UserName]]

Example:

"emailSubject":"[[Signer 1_UserName]], Please sign this NDA",

To add a recipient’s email address in the subject line, add the following text in the emailSubject property when you create the template or send an envelope from the template:

[[<roleName>_Email]]

Example:

"emailSubject":"[[Signer 1_Email]], Please sign this NDA",

In these examples, the role name specified in the template is “Signer 1”. When the envelope is sent, the placeholder will be dynamically substituted with the recipient’s name or email.

Creating multiple templates

To create multiple templates, you provide a zip file of JSON files. You can also use the Templates::ListTemplates method with the is_download query parameter to download a zip file containing your existing templates and use that as a guide. The API supports both .zip and .gzip file formats as input.

You also need to set the following headers:

  • Content-Length

  • Content-Type

  • Content-Disposition

Example:

Content-Length: 71068 Content-Type: application/zip Content-Disposition: file; filename="DocuSignTemplates_Nov_25_2019_20_40_21.zip"; fileExtension=.zip

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Custom Fields Post Template Custom Fields

<docusign:create-v21-accounts-templates-custom-fields-by-account-id-template-id>

Creates custom document fields in an existing template document. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/custom_fields endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Document Fields Post Template Document Fields

<docusign:create-v21-accounts-templates-documents-fields-by-account-id-template-id-document-id>

Creates custom document fields in an existing template document. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/fields endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Responsive Html Post Template Document Responsive Html Preview

<docusign:create-v21-accounts-templates-documents-responsive-html-preview-by-account-id-template-id-document-id>

Creates a preview of the responsive, HTML version of a specific template document. This method enables you to preview a PDF document conversion to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the signing document.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/responsive_html_preview endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Tabs Post Template Document Tabs

<docusign:create-v21-accounts-templates-documents-tabs-by-account-id-template-id-document-id>

This method creates Template Document Tabs. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/documents/{documentId}/tabs endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Lock Post Template Lock

<docusign:create-v21-accounts-templates-lock-by-account-id-template-id>

Locks the specified template and sets the time until the lock expires to prevent other users or recipients from changing the template. The response to this request returns a lockToken parameter. You must use the lockToken to update or delete an existing lock. You must also include the lockToken in the header for every PUT call that you make on the template while the template is locked. If you do not include the lockToken, the system returns the following error:

{ "errorCode": "EDIT_LOCK_NOT_LOCK_OWNER", "message": "The user is not the owner of the lock. The template is locked by another user or in another application" }

Users must have envelope locking capability enabled to use this function (the userSetting property canLockEnvelopes must be set to true for the user).

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/lock endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Recipients Post Template Recipients

<docusign:create-v21-accounts-templates-recipients-by-account-id-template-id>

Adds one or more recipients to a template. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Recipients Post Template Recipient Tabs

<docusign:create-v21-accounts-templates-recipients-tabs-by-account-id-template-id-recipient-id>

Adds one or more tabs for a recipient. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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 recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Responsive Html Post Template Responsive Html Preview

<docusign:create-v21-accounts-templates-responsive-html-preview-by-account-id-template-id>

Creates a preview of the [responsive](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/api-overview), HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions to responsive HTML across device types prior to sending. The request body is a documentHtmlDefinition object, which holds the responsive signing parameters that define how to generate the HTML version of the documents.

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/responsive_html_preview endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Views Post Template Edit View

<docusign:create-v21-accounts-templates-views-edit-by-account-id-template-id>

This method returns a URL for starting an edit view of a template that uses the DocuSign Template UI. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/views/edit endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Views Post Template Recipient Preview

<docusign:create-v21-accounts-templates-views-recipient-preview-by-account-id-template-id>

This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Users Post Users

<docusign:create-v21-accounts-users-by-account-id>

Adds new users to an account. The body of this request is an array of newUsers objects. For each new user, you must provide at least the userName and email properties. The userSettings property specifies the actions users can perform. In the example below, Tal Mason will be able to send envelopes, and the activation email is in French because the locale is set to fr.

POST /restapi/v2.1/accounts/{accountId}/users
Content-Type: application/json
{
	"newUsers": [{
		"userName": "Claire Horace",
		"email": "claire@example.com"
	}, {
		"userName": "Tal Mason",
		"email": "talmason@example.com",
		"company": "TeleSel",
		"userSettings": {
			"locale": "fr",
			"canSendEnvelope": true
		}
	}]
}

A successful response is a newUsers array with information about the newly created users. If there was a problem in creating a user, that user entry will contain an errorDetails property that describes what went wrong.

{
	"newUsers": [{
		"userId": "18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade",
		"uri": "/users/18f3be12-xxxx-xxxx-xxxx-883d8f9b8ade",
		"email": "claire@example.com",
		"userName": "Claire Horace",
		"createdDateTime": "0001-01-01T08:00:00.0000000Z",
		"errorDetails": {
			"errorCode": "USER_ALREADY_EXISTS_IN_ACCOUNT",
			"message": "Username and email combination already exists for this account."
		}
	}, {
		"userId": "be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33",
		"uri": "/users/be9899a3-xxxx-xxxx-xxxx-2c8dd7156e33",
		"email": "talmason@example.com",
		"userName": "Tal Mason",
		"userStatus": "ActivationSent",
		"createdDateTime": "2020-05-26T23:25:30.7330000Z"
	}]
}

This operation makes an HTTP POST request to the /v2.1/accounts/{accountId}/users endpoint.

Parameters

Name Type Description Default Value Required

Configuration

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

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, userId can represent another user whom the Administrator is accessing.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

User Signatures 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-Type is set to application/json, then the default behavior for creating a default signature image, based on the name and a DocuSign font, is used.

  • If Content-Type is set to multipart/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, userId can represent another user whom the Administrator is accessing.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Views Post 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Workspace 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Workspace File 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Notary 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Notary Jurisdictions 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Brands 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Brand 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Brand Logo 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: - primary - secondary - email

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Bulk Send V2CRUD 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Chunked Uploads 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Connect 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Connect 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Connect 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Connect 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Contacts 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Contacts 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Account Custom Fields 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Attachments 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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Custom Fields 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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Documents 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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Document Fields 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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

x

Envelope Id

String

The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Pages 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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

x

Envelope Id

String

The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Tabs 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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

x

Envelope Id

String

The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Templates 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 documentId is set by the API client. It is an integer that falls between 1 and 2,147,483,647. The value is encoded as a string without commas. The values 1, 2, 3, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a documentId property that specifies the document on which to place the tab.

x

Envelope Id

String

The envelope’s GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Email Settings 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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Lock 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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Recipients 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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Recipients 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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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 recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Recipients 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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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 recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Envelope Transfer Rules 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Views 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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Envelope Workflow Definition 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: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE

Favorite Templates 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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Any

Attributes Type

For Configurations

Throws

  • DOCUSIGN:BAD_REQUEST

  • DOCUSIGN:CLIENT_ERROR

  • DOCUSIGN:CONNECTIVITY

  • DOCUSIGN:INTERNAL_SERVER_ERROR

  • DOCUSIGN:NOT_ACCEPTABLE

  • DOCUSIGN:NOT_FOUND

  • DOCUSIGN:RETRY_EXHAUSTED

  • DOCUSIGN:SERVER_ERROR

  • DOCUSIGN:SERVICE_UNAVAILABLE

  • DOCUSIGN:TIMEOUT

  • DOCUSIGN:TOO_MANY_REQUESTS

  • DOCUSIGN:UNAUTHORIZED

  • DOCUSIGN:UNSUPPORTED_MEDIA_TYPE