docusign.dsesign
Module docusign.dsesign
API
Definitions
ballerinax/docusign.dsesign Ballerina library
Overview
DocuSign is a digital transaction management platform that enables users to securely sign, send, and manage documents electronically.
The Ballerina DocuSign eSignature connector integrates with the DocuSign platform, provides APIs for tasks such as sending documents for signature, managing envelopes, and retrieving status updates, enhancing the efficiency of electronic signature processes within Ballerina applications. It supports DocuSign eSignature API V2.1.
Setup guide
To utilize the eSignature connector, you must have access to the DocuSign REST API through a DocuSign account.
Step 1: Create a DocuSign account
In order to use the DocuSign eSignature connector, you need to first create the DocuSign credentials for the connector to interact with DocuSign.
-
You can create an account for free at the Developer Center.
Step 2: Create integration key and secret key
-
Create an integration key: Visit the Apps and Keys page on DocuSign. Click on
Add App and Integration Key,
provide a name for the app, and clickCreate App
. This will generate anIntegration Key
. -
Generate a secret key: Under the
Authentication
section, click onAdd Secret Key
. This will generate a secret Key. Make sure to copy and save both theIntegration Key
andSecret Key
.
Step 3: Generate refresh token
-
Add a redirect URI: Click on
Add URI
and enter your redirect URI (e.g., http://www.example.com/callback). -
Generate the encoded key: The
Encoded Key
is a base64 encoded string of yourIntegration key
andSecret Key
in the format{IntegrationKey:SecretKey}
. You can generate this in your web browser's console using thebtoa()
function:btoa('IntegrationKey:SecretKey')
. You can either generate the encoded key from an online base64 encoder. -
Get the authorization code: Visit the following URL in your web browser, replacing
{iKey}
with your Integration Key and{redirectUri}
with your redirect URI.https://account-d.docusign.com/oauth/auth?response_type=code&scope=signature%20impersonation&client_id={iKey}&redirect_uri={redirectUri}
This will redirect you to your Redirect URI with a
code
query parameter. This is yourauthorization code
. -
Get the refresh token: Use the following
curl
command to get the refresh token, replacing{encodedKey}
with your Encoded Key and{codeFromUrl}
with yourauthorization code
.curl --location 'https://account-d.docusign.com/oauth/token' \ --header 'Authorization: Basic {encodedKey}' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data-urlencode 'code={codeFromUrl}' \ --data-urlencode 'grant_type=authorization_code'
The response will contain your refresh token. Use
https://account-d.docusign.com/oauth/token
as the refresh URL.
Remember to replace {IntegrationKey:SecretKey}
, {iKey}
, {redirectUri}
, {encodedKey}
, and {codeFromUrl}
with your actual values.
Above is about using the DocuSign eSignature APIs in the developer mode. If your app is ready to go live, you need to follow the guidelines given here to make it work.
Quickstart
To use the DocuSign eSignature connector in your Ballerina project, modify the .bal
file as follows.
Step 1: Import the module
Import the ballerinax/docusign.dsesign
module into your Ballerina project.
import ballerinax/docusign.dsesign;
Step 2: Instantiate a new connector
Create a dsesign:ConnectionConfig
with the obtained OAuth2.0 tokens and initialize the connector with it.
configurable string clientId = ?; configurable string clientSecret = ?; configurable string refreshToken = ?; configurable string refreshUrl = ?; dsesign:Client docusignClient = check new({ auth: { clientId, clientSecret, refreshToken, refreshUrl }, serviceUrl = "https://demo.docusign.net/restapi" });
Step 3: Invoke the connector operation
You can now utilize the operations available within the connector.
public function main() returns error? { // Creates an envelope dsesign:EnvelopeSummary newEnvelope = check docusignClient->/accounts/[accountId]/envelopes.post({ documents: [ { documentBase64: "base64-encoded-pdf-file", documentId: "1", fileExtension: "pdf", name: "document" } ], emailSubject: "Simple Signing Example 02", recipients: { signers: [ { email: "randomtester12@corp.com", name: "randomtester12", recipientId: "12" } ] }, status: "sent" }); // Retrieves specific sets of envelopes from a given date dsesign:EnvelopesInformation envelope = check docusignClient->/accounts/[accountId]/envelopes(from_date = "2024-01-01T00:00Z"); }
Hint: To apply a value to the
documentBase64
field, you can either use an online tool designed to convert a PDF file into a base64-encoded string, or you can refer to the provided example code
Step 4: Run the Ballerina application
Use the following command to compile and run the Ballerina program.
bal run
Examples
The DocuSign eSignature connector provides practical examples illustrating usage in various scenarios. Explore these examples.
-
Send documents for esignatures This example shows how to use DocuSign eSignature APIs to send envelope to recipients to add their respective esignatures to documents in the envelope.
-
Create esignatures This example shows how to create a eSignature for your DocuSign account.
Clients
docusign.dsesign: Client
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
Constructor
Gets invoked to initialize the connector
.
init (string serviceUrl, *ConnectionConfig config)
- serviceUrl string - URL of the target service
- config *ConnectionConfig - The configurations to be used when initializing the
connector
get service_information
function get service_information() returns ServiceInformation|error
Retrieves the available REST API versions.
Return Type
- ServiceInformation|error - A successful response or an error.
get ["v2.1"]
function get ["v2.1"]() returns ResourceInformation|error
Lists resources for REST version specified
Return Type
- ResourceInformation|error - A successful response or an error.
post accounts
function post accounts(NewAccountDefinition payload) returns NewAccountSummary|error
Creates new accounts.
Parameters
- payload NewAccountDefinition -
Return Type
- NewAccountSummary|error - A successful response or an error.
get accounts/[string accountId]
function get accounts/[string accountId](string? include_account_settings) returns AccountInformation|error
Retrieves the account information for the specified account.
Parameters
- include_account_settings string? (default ()) - When true, includes account settings in the response. The default value is false.
Return Type
- AccountInformation|error - A successful response or an error.
delete accounts/[string accountId]
Deletes the specified account.
Parameters
- redact_user_data string? (default ()) -
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/billing_charges
function get accounts/[string accountId]/billing_charges(string? include_charges) returns BillingChargeResponse|error
Gets list of recurring and usage charges for the account.
Parameters
- include_charges string? (default ()) - Specifies which billing charges to return.
Valid values are:
- envelopes
- seats
Return Type
- BillingChargeResponse|error - A successful response or an error.
get accounts/[string accountId]/billing_invoices
function get accounts/[string accountId]/billing_invoices(string? from_date, string? to_date) returns BillingInvoicesResponse|error
Get a List of Billing Invoices
Parameters
- from_date string? (default ()) - Specifies the date/time of the earliest invoice in the account to retrieve.
- to_date string? (default ()) - Specifies the date/time of the latest invoice in the account to retrieve.
Return Type
- BillingInvoicesResponse|error - A successful response or an error.
get accounts/[string accountId]/billing_invoices/[string invoiceId]
function get accounts/[string accountId]/billing_invoices/[string invoiceId]() returns BillingInvoice|error
Retrieves a billing invoice.
Return Type
- BillingInvoice|error - A successful response or an error.
get accounts/[string accountId]/billing_invoices_past_due
function get accounts/[string accountId]/billing_invoices_past_due() returns BillingInvoicesSummary|error
Get a list of past due invoices.
Return Type
- BillingInvoicesSummary|error - A successful response or an error.
get accounts/[string accountId]/billing_payments
function get accounts/[string accountId]/billing_payments(string? from_date, string? to_date) returns BillingPaymentsResponse|error
Gets payment information for one or more payments.
Parameters
- from_date string? (default ()) - Specifies the date/time of the earliest payment in the account to retrieve.
- to_date string? (default ()) - Specifies the date/time of the latest payment in the account to retrieve.
Return Type
- BillingPaymentsResponse|error - A successful response or an error.
post accounts/[string accountId]/billing_payments
function post accounts/[string accountId]/billing_payments(BillingPaymentRequest payload) returns BillingPaymentResponse|error
Posts a payment to a past due invoice.
Parameters
- payload BillingPaymentRequest -
Return Type
- BillingPaymentResponse|error - A successful response or an error.
get accounts/[string accountId]/billing_payments/[string paymentId]
function get accounts/[string accountId]/billing_payments/[string paymentId]() returns BillingPaymentItem|error
Gets billing payment information for a specific payment.
Return Type
- BillingPaymentItem|error - A successful response or an error.
get accounts/[string accountId]/billing_plan
function get accounts/[string accountId]/billing_plan(string? include_credit_card_information, string? include_downgrade_information, string? include_metadata, string? include_successor_plans, string? include_tax_exempt_id) returns AccountBillingPlanResponse|error
Get Account Billing Plan
Parameters
- include_credit_card_information string? (default ()) - When true, payment information including credit card information will show in the return.
- include_downgrade_information string? (default ()) -
- include_metadata string? (default ()) - When true, the
canUpgrade
andrenewalStatus
properties are included the response and an array ofsupportedCountries
is added to thebillingAddress
information.
- include_successor_plans string? (default ()) - When true, excludes successor information from the response.
- include_tax_exempt_id string? (default ()) -
Return Type
- AccountBillingPlanResponse|error - A successful response or an error.
put accounts/[string accountId]/billing_plan
function put accounts/[string accountId]/billing_plan(BillingPlanInformation payload, string? preview_billing_plan) returns BillingPlanUpdateResponse|error
Updates an account billing plan.
Parameters
- payload BillingPlanInformation -
- preview_billing_plan string? (default ()) - When true, updates the account using a preview billing plan.
Return Type
- BillingPlanUpdateResponse|error - A successful response or an error.
get accounts/[string accountId]/billing_plan/credit_card
function get accounts/[string accountId]/billing_plan/credit_card() returns CreditCardInformation|error
Get credit card information
Return Type
- CreditCardInformation|error - A successful response or an error.
get accounts/[string accountId]/billing_plan/downgrade
function get accounts/[string accountId]/billing_plan/downgrade() returns DowngradRequestBillingInfoResponse|error
Returns downgrade plan information for the specified account.
Return Type
- DowngradRequestBillingInfoResponse|error - A successful response or an error.
put accounts/[string accountId]/billing_plan/downgrade
function put accounts/[string accountId]/billing_plan/downgrade(DowngradeBillingPlanInformation payload) returns DowngradePlanUpdateResponse|error
Queues downgrade billing plan request for an account.
Parameters
- payload DowngradeBillingPlanInformation -
Return Type
- DowngradePlanUpdateResponse|error - A successful response or an error.
put accounts/[string accountId]/billing_plan/purchased_envelopes
function put accounts/[string accountId]/billing_plan/purchased_envelopes(PurchasedEnvelopesInformation payload) returns error?
Reserved: Purchase additional envelopes.
Parameters
- payload PurchasedEnvelopesInformation -
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/brands
function get accounts/[string accountId]/brands(string? exclude_distributor_brand, string? include_logos) returns AccountBrands|error
Gets a list of brands.
Parameters
- exclude_distributor_brand string? (default ()) - When true, excludes distributor brand information from the response set.
- include_logos string? (default ()) - When true, returns the logos associated with the brand.
Return Type
- AccountBrands|error - A successful response or an error.
post accounts/[string accountId]/brands
function post accounts/[string accountId]/brands(Brand payload) returns AccountBrands|error
Creates one or more brand profiles for an account.
Parameters
- payload Brand -
Return Type
- AccountBrands|error - A successful response or an error.
delete accounts/[string accountId]/brands
function delete accounts/[string accountId]/brands(BrandsRequest payload) returns AccountBrands|error
Deletes one or more brand profiles.
Parameters
- payload BrandsRequest -
Return Type
- AccountBrands|error - A successful response or an error.
get accounts/[string accountId]/brands/[string brandId]
function get accounts/[string accountId]/brands/[string brandId](string? include_external_references, string? include_logos) returns Brand|error
Gets information about a brand.
Parameters
- include_external_references string? (default ()) - When true, the landing pages and links associated with the brand are included in the response.
- include_logos string? (default ()) - When true, the URIs for the logos associated with the brand are included in the response.
put accounts/[string accountId]/brands/[string brandId]
function put accounts/[string accountId]/brands/[string brandId](Brand payload, string? replace_brand) returns Brand|error
Updates an existing brand.
Parameters
- payload Brand -
- replace_brand string? (default ()) - When true, replaces the brand instead of updating it. The only unchanged value is the brand ID. The request body must be XML. The default value is false.
delete accounts/[string accountId]/brands/[string brandId]
function delete accounts/[string accountId]/brands/[string brandId]() returns error?
Deletes a brand.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/brands/[string brandId]/file
function get accounts/[string accountId]/brands/[string brandId]/file() returns error?
Exports a brand.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/brands/[string brandId]/logos/[string logoType]
function get accounts/[string accountId]/brands/[string brandId]/logos/[string logoType]() returns byte[]|error
Gets a brand logo.
Return Type
- byte[]|error - A successful response or an error.
put accounts/[string accountId]/brands/[string brandId]/logos/[string logoType]
function put accounts/[string accountId]/brands/[string brandId]/logos/[string logoType](byte[] payload) returns error?
Updates a brand logo.
Parameters
- payload byte[] - Brand logo binary Stream. Supported formats: JPG, GIF, PNG. Maximum file size: 300 KB. Recommended dimensions: 296 x 76 pixels (larger images will be resized). Changes may take up to one hour to display in all places
Return Type
- error? - A successful response or an error.
delete accounts/[string accountId]/brands/[string brandId]/logos/[string logoType]
function delete accounts/[string accountId]/brands/[string brandId]/logos/[string logoType]() returns error?
Deletes a brand logo.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/brands/[string brandId]/resources
function get accounts/[string accountId]/brands/[string brandId]/resources() returns BrandResourcesList|error
Returns metadata about the branding resources for an account.
Return Type
- BrandResourcesList|error - A successful response or an error.
get accounts/[string accountId]/brands/[string brandId]/resources/[string resourceContentType]
function get accounts/[string accountId]/brands/[string brandId]/resources/[string resourceContentType](string? langcode, string? return_master) returns error?
Returns a branding resource file.
Parameters
- langcode string? (default ()) - The ISO 3166-1 alpha-2 codes for the languages that the brand supports.
- return_master string? (default ()) - Specifies which resource file data to return. When true, only the master resource file is returned. When false, only the elements that you modified are returned.
Return Type
- error? - A successful response or an error.
put accounts/[string accountId]/brands/[string brandId]/resources/[string resourceContentType]
function put accounts/[string accountId]/brands/[string brandId]/resources/[string resourceContentType](Resources_resourceContentType_body payload) returns BrandResources|error
Updates a branding resource file.
Parameters
- payload Resources_resourceContentType_body -
Return Type
- BrandResources|error - A successful response or an error.
get accounts/[string accountId]/bulk_send_batch
function get accounts/[string accountId]/bulk_send_batch(string? batch_ids, string? count, string? from_date, string? search_text, string? start_position, string? status, string? to_date, string? user_id) returns BulkSendBatchSummaries|error
Returns a list of bulk send batch summaries.
Parameters
- batch_ids string? (default ()) - A comma-separated list of batch IDs to query.
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip. Valid values:1
to100
<br> Default:100
- from_date string? (default ()) - The start date for a date range in UTC DateTime format. Note: If this property is null, no date filtering is applied.
- search_text string? (default ()) - Use this parameter to search for specific text.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
- status string? (default ()) - The kind of results to collect. Must be one of:
- all
- failed
- sent
- queued
- to_date string? (default ()) - The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. Note: If this property is null, the value defaults to the current date.
- user_id string? (default ()) -
Return Type
- BulkSendBatchSummaries|error - A successful response or an error.
get accounts/[string accountId]/bulk_send_batch/[string bulkSendBatchId]
function get accounts/[string accountId]/bulk_send_batch/[string bulkSendBatchId]() returns BulkSendBatchStatus|error
Gets the status of a specific bulk send batch.
Return Type
- BulkSendBatchStatus|error - A successful response or an error.
put accounts/[string accountId]/bulk_send_batch/[string bulkSendBatchId]
function put accounts/[string accountId]/bulk_send_batch/[string bulkSendBatchId](BulkSendBatchRequest payload) returns BulkSendBatchStatus|error
Updates the name of a bulk send batch.
Parameters
- payload BulkSendBatchRequest -
Return Type
- BulkSendBatchStatus|error - A successful response or an error.
put accounts/[string accountId]/bulk_send_batch/[string bulkSendBatchId]/[string bulkAction]
function put accounts/[string accountId]/bulk_send_batch/[string bulkSendBatchId]/[string bulkAction](BulkSendBatchActionRequest payload) returns BulkSendBatchStatus|error
Applies a bulk action to all envelopes from a specified bulk send.
Parameters
- payload BulkSendBatchActionRequest -
Return Type
- BulkSendBatchStatus|error - A successful response or an error.
get accounts/[string accountId]/bulk_send_batch/[string bulkSendBatchId]/envelopes
function get accounts/[string accountId]/bulk_send_batch/[string bulkSendBatchId]/envelopes(string? count, string? include, string? 'order, string? order_by, string? search_text, string? start_position, string? status) returns EnvelopesInformation|error
Gets envelopes from a specific bulk send batch.
Parameters
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip. Valid values:1
to1000
- include string? (default ()) - When
recipients
, only envelopes with recipient nodes will be included in the response.
- 'order string? (default ()) - The order in which to sort the results. Valid values are:
- Descending order:
desc
(default) - Ascending order:
asc
- Descending order:
- order_by string? (default ()) - The envelope attribute used to sort the results. Valid values are:
created
(default)completed
last_modified
sent
status
subject
status_changed
- search_text string? (default ()) - Use this parameter to search for specific text.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
- status string? (default ()) - Comma-separated list of envelope statuses.
Note that
any
should not be included with other statuses. In other words,any
is a valid parameter value, butany,sent
is not. Use the valuedeliveryfailure
to get all envelopes withAuthFailed
andAutoResponded
status. This value is specific to bulk sending.
Return Type
- EnvelopesInformation|error - A successful response or an error.
get accounts/[string accountId]/bulk_send_lists
function get accounts/[string accountId]/bulk_send_lists() returns BulkSendingListSummaries|error
Gets bulk send lists.
Return Type
- BulkSendingListSummaries|error - A successful response or an error.
post accounts/[string accountId]/bulk_send_lists
function post accounts/[string accountId]/bulk_send_lists(BulkSendingList payload) returns BulkSendingList|error
Creates a bulk send list.
Parameters
- payload BulkSendingList -
Return Type
- BulkSendingList|error - A successful response or an error.
get accounts/[string accountId]/bulk_send_lists/[string bulkSendListId]
function get accounts/[string accountId]/bulk_send_lists/[string bulkSendListId]() returns BulkSendingList|error
Gets a specific bulk send list.
Return Type
- BulkSendingList|error - A successful response or an error.
put accounts/[string accountId]/bulk_send_lists/[string bulkSendListId]
function put accounts/[string accountId]/bulk_send_lists/[string bulkSendListId](BulkSendingList payload) returns BulkSendingList|error
Updates a bulk send list.
Parameters
- payload BulkSendingList -
Return Type
- BulkSendingList|error - A successful response or an error.
delete accounts/[string accountId]/bulk_send_lists/[string bulkSendListId]
function delete accounts/[string accountId]/bulk_send_lists/[string bulkSendListId]() returns BulkSendingListSummaries|error
Deletes a bulk send list.
Return Type
- BulkSendingListSummaries|error - A successful response or an error.
post accounts/[string accountId]/bulk_send_lists/[string bulkSendListId]/send
function post accounts/[string accountId]/bulk_send_lists/[string bulkSendListId]/send(BulkSendRequest payload) returns BulkSendResponse|error
Creates a bulk send request.
Parameters
- payload BulkSendRequest -
Return Type
- BulkSendResponse|error - A successful response or an error.
post accounts/[string accountId]/bulk_send_lists/[string bulkSendListId]/test
function post accounts/[string accountId]/bulk_send_lists/[string bulkSendListId]/test(BulkSendRequest payload) returns BulkSendTestResponse|error
Creates a bulk send test.
Parameters
- payload BulkSendRequest -
Return Type
- BulkSendTestResponse|error - A successful response or an error.
delete accounts/[string accountId]/captive_recipients/[string recipientPart]
function delete accounts/[string accountId]/captive_recipients/[string recipientPart](CaptiveRecipientInformation payload) returns CaptiveRecipientInformation|error
Deletes the signature for one or more captive recipient records.
Parameters
- payload CaptiveRecipientInformation -
Return Type
- CaptiveRecipientInformation|error - A successful response or an error.
post accounts/[string accountId]/chunked_uploads
function post accounts/[string accountId]/chunked_uploads(ChunkedUploadRequest payload) returns ChunkedUploadResponse|error
Initiate a new chunked upload.
Parameters
- payload ChunkedUploadRequest -
Return Type
- ChunkedUploadResponse|error - A successful response or an error.
get accounts/[string accountId]/chunked_uploads/[string chunkedUploadId]
function get accounts/[string accountId]/chunked_uploads/[string chunkedUploadId](string? include) returns ChunkedUploadResponse|error
Retrieves metadata about a chunked upload.
Parameters
- include string? (default ()) - (Optional) This parameter enables you to include additional attribute data in the response. The valid value for this method is
checksum
, which returns an SHA256 checksum of the content of the chunked upload in the response. You can use compare this checksum against your own checksum of the original content to verify that there are no missing parts before you attempt to commit the chunked upload.
Return Type
- ChunkedUploadResponse|error - A successful response or an error.
put accounts/[string accountId]/chunked_uploads/[string chunkedUploadId]
function put accounts/[string accountId]/chunked_uploads/[string chunkedUploadId](string? action) returns ChunkedUploadResponse|error
Commit a chunked upload.
Parameters
- action string? (default ()) - (Required) You must use this query parameter with the value
commit
, which affirms the request to validate and prepare the chunked upload for use with other API calls.
Return Type
- ChunkedUploadResponse|error - A successful response or an error.
delete accounts/[string accountId]/chunked_uploads/[string chunkedUploadId]
function delete accounts/[string accountId]/chunked_uploads/[string chunkedUploadId]() returns ChunkedUploadResponse|error
Deletes a chunked upload.
Return Type
- ChunkedUploadResponse|error - A successful response or an error.
put accounts/[string accountId]/chunked_uploads/[string chunkedUploadId]/[string chunkedUploadPartSeq]
function put accounts/[string accountId]/chunked_uploads/[string chunkedUploadId]/[string chunkedUploadPartSeq](ChunkedUploadRequest payload) returns ChunkedUploadResponse|error
Add a chunk to an existing chunked upload.
Parameters
- payload ChunkedUploadRequest -
Return Type
- ChunkedUploadResponse|error - A successful response or an error.
get accounts/[string accountId]/connect
function get accounts/[string accountId]/connect() returns ConnectConfigResults|error
Get Connect configuration information.
Return Type
- ConnectConfigResults|error - A successful response or an error.
put accounts/[string accountId]/connect
function put accounts/[string accountId]/connect(ConnectCustomConfiguration payload) returns ConnectCustomConfiguration|error
Updates a specified Connect configuration.
Parameters
- payload ConnectCustomConfiguration -
Return Type
- ConnectCustomConfiguration|error - A successful response or an error.
post accounts/[string accountId]/connect
function post accounts/[string accountId]/connect(ConnectCustomConfiguration payload) returns ConnectCustomConfiguration|error
Creates a Connect configuration.
Parameters
- payload ConnectCustomConfiguration -
Return Type
- ConnectCustomConfiguration|error - A successful response or an error.
get accounts/[string accountId]/connect/[string connectId]
function get accounts/[string accountId]/connect/[string connectId]() returns ConnectConfigResults|error
Gets the details about a Connect configuration.
Return Type
- ConnectConfigResults|error - A successful response or an error.
delete accounts/[string accountId]/connect/[string connectId]
function delete accounts/[string accountId]/connect/[string connectId]() returns error?
Deletes the specified Connect configuration.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/connect/[string connectId]/all/users
function get accounts/[string accountId]/connect/[string connectId]/all/users(string? count, string? domain_users_only, string? email_substring, string? start_position, string? status, string? user_name_substring) returns IntegratedConnectUserInfoList|error
Returns all users from the configured Connect service.
Parameters
- count string? (default ()) - The maximum number of results to return.
- domain_users_only string? (default ()) -
- email_substring string? (default ()) - Filters returned user records by full email address or a substring of email address.
- start_position string? (default ()) - The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
- status string? (default ()) - The status of the item.
- user_name_substring string? (default ()) - Filters results based on a full or partial user name. Note: When you enter a partial user name, you do not use a wildcard character.
Return Type
- IntegratedConnectUserInfoList|error - A successful response or an error.
get accounts/[string accountId]/connect/[string connectId]/users
function get accounts/[string accountId]/connect/[string connectId]/users(string? count, string? email_substring, string? list_included_users, string? start_position, string? status, string? user_name_substring) returns IntegratedUserInfoList|error
Returns users from the configured Connect service.
Parameters
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip.
- email_substring string? (default ()) - Filters returned user records by full email address or a substring of email address.
- list_included_users string? (default ()) -
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
- status string? (default ()) - Filters the results by user status.
You can specify a comma-separated
list of the following statuses:
- ActivationRequired
- ActivationSent
- Active
- Closed
- Disabled
- user_name_substring string? (default ()) - Filters results based on a full or partial user name. Note: When you enter a partial user name, you do not use a wildcard character.
Return Type
- IntegratedUserInfoList|error - A successful response or an error.
put accounts/[string accountId]/connect/envelopes/[string envelopeId]/retry_queue
function put accounts/[string accountId]/connect/envelopes/[string envelopeId]/retry_queue() returns ConnectFailureResults|error
Republishes Connect information for the specified envelope.
Return Type
- ConnectFailureResults|error - A successful response or an error.
post accounts/[string accountId]/connect/envelopes/publish/historical
function post accounts/[string accountId]/connect/envelopes/publish/historical(ConnectHistoricalEnvelopeRepublish payload) returns EnvelopePublishTransaction|error
Submits a batch of historical envelopes for republish to a webhook.
Parameters
- payload ConnectHistoricalEnvelopeRepublish -
Return Type
- EnvelopePublishTransaction|error - A successful response or an error.
put accounts/[string accountId]/connect/envelopes/retry_queue
function put accounts/[string accountId]/connect/envelopes/retry_queue(ConnectFailureFilter payload) returns ConnectFailureResults|error
Republishes Connect information for multiple envelopes.
Parameters
- payload ConnectFailureFilter -
Return Type
- ConnectFailureResults|error - A successful response or an error.
get accounts/[string accountId]/connect/failures
function get accounts/[string accountId]/connect/failures(string? from_date, string? to_date) returns ConnectLogs|error
Gets the Connect failure log information.
Parameters
- from_date string? (default ()) - The start date for a date range in UTC DateTime format. Note: If this property is null, no date filtering is applied.
- to_date string? (default ()) - The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. Note: If this property is null, the value defaults to the current date.
Return Type
- ConnectLogs|error - A successful response or an error.
delete accounts/[string accountId]/connect/failures/[string failureId]
function delete accounts/[string accountId]/connect/failures/[string failureId]() returns ConnectDeleteFailureResult|error
Deletes a Connect failure log entry.
Return Type
- ConnectDeleteFailureResult|error - A successful response or an error.
get accounts/[string accountId]/connect/logs
function get accounts/[string accountId]/connect/logs(string? from_date, string? to_date) returns ConnectLogs|error
Gets the Connect log.
Parameters
- from_date string? (default ()) - The start date for a date range in UTC DateTime format. Note: If this property is null, no date filtering is applied.
- to_date string? (default ()) - The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. Note: If this property is null, the value defaults to the current date.
Return Type
- ConnectLogs|error - A successful response or an error.
delete accounts/[string accountId]/connect/logs
function delete accounts/[string accountId]/connect/logs() returns error?
Deletes a list of Connect log entries.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/connect/logs/[string logId]
function get accounts/[string accountId]/connect/logs/[string logId](string? additional_info) returns ConnectLog|error
Gets a Connect log entry.
Parameters
- additional_info string? (default ()) - When true, the response includes the
connectDebugLog
information.
Return Type
- ConnectLog|error - A successful response or an error.
delete accounts/[string accountId]/connect/logs/[string logId]
function delete accounts/[string accountId]/connect/logs/[string logId]() returns error?
Deletes a specified Connect log entry.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/connect/oauth
function get accounts/[string accountId]/connect/oauth() returns ConnectOAuthConfig|error
Retrieves the Connect OAuth information for the account.
Return Type
- ConnectOAuthConfig|error - A successful response or an error.
put accounts/[string accountId]/connect/oauth
function put accounts/[string accountId]/connect/oauth(ConnectOAuthConfig payload) returns ConnectOAuthConfig|error
Updates the existing Connect OAuth configuration for the account.
Parameters
- payload ConnectOAuthConfig -
Return Type
- ConnectOAuthConfig|error - A successful response or an error.
post accounts/[string accountId]/connect/oauth
function post accounts/[string accountId]/connect/oauth(ConnectOAuthConfig payload) returns ConnectOAuthConfig|error
Set up Connect OAuth for the specified account.
Parameters
- payload ConnectOAuthConfig -
Return Type
- ConnectOAuthConfig|error - A successful response or an error.
delete accounts/[string accountId]/connect/oauth
function delete accounts/[string accountId]/connect/oauth() returns error?
Delete the Connect OAuth configuration.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/consumer_disclosure
function get accounts/[string accountId]/consumer_disclosure(string? langCode) returns AccountConsumerDisclosures|error
Gets the default Electronic Record and Signature Disclosure for an account.
Parameters
- langCode string? (default ()) - The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:
- Arabic (
ar
) - Bulgarian (
bg
) - Czech (
cs
) - Chinese Simplified (
zh_CN
) - Chinese Traditional (
zh_TW
) - Croatian (
hr
) - Danish (
da
) - Dutch (
nl
) - English US (
en
) - English UK (
en_GB
) - Estonian (
et
) - Farsi (
fa
) - Finnish (
fi
) - French (
fr
) - French Canadian (
fr_CA
) - German (
de
) - Greek (
el
) - Hebrew (
he
) - Hindi (
hi
) - Hungarian (
hu
) - Bahasa Indonesian (
id
) - Italian (
it
) - Japanese (
ja
) - Korean (
ko
) - Latvian (
lv
) - Lithuanian (
lt
) - Bahasa Melayu (
ms
) - Norwegian (
no
) - Polish (
pl
) - Portuguese (
pt
) - Portuguese Brazil (
pt_BR
) - Romanian (
ro
) - Russian (
ru
) - Serbian (
sr
) - Slovak (
sk
) - Slovenian (
sl
) - Spanish (
es
) - Spanish Latin America (
es_MX
) - Swedish (
sv
) - Thai (
th
) - Turkish (
tr
) - Ukrainian (
uk
) - Vietnamese (
vi
) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value tobrowser
.
- Arabic (
Return Type
- AccountConsumerDisclosures|error - A successful response or an error.
get accounts/[string accountId]/consumer_disclosure/[string langCode]
function get accounts/[string accountId]/consumer_disclosure/[string langCode]() returns AccountConsumerDisclosures|error
Gets the Electronic Record and Signature Disclosure for an account.
Return Type
- AccountConsumerDisclosures|error - A successful response or an error.
put accounts/[string accountId]/consumer_disclosure/[string langCode]
function put accounts/[string accountId]/consumer_disclosure/[string langCode](ConsumerDisclosure payload, string? include_metadata) returns ConsumerDisclosure|error
Updates the Electronic Record and Signature Disclosure for an account.
Parameters
- payload ConsumerDisclosure -
- include_metadata string? (default ()) - (Optional) When true, the response includes metadata indicating which properties are editable.
Return Type
- ConsumerDisclosure|error - A successful response or an error.
put accounts/[string accountId]/contacts
function put accounts/[string accountId]/contacts(ContactModRequest payload) returns ContactUpdateResponse|error
Updates one or more contacts.
Parameters
- payload ContactModRequest -
Return Type
- ContactUpdateResponse|error - A successful response or an error.
post accounts/[string accountId]/contacts
function post accounts/[string accountId]/contacts(ContactModRequest payload) returns ContactUpdateResponse|error
Add contacts to a contacts list.
Parameters
- payload ContactModRequest -
Return Type
- ContactUpdateResponse|error - A successful response or an error.
delete accounts/[string accountId]/contacts
function delete accounts/[string accountId]/contacts(ContactModRequest payload) returns ContactUpdateResponse|error
Deletes multiple contacts from an account.
Parameters
- payload ContactModRequest -
Return Type
- ContactUpdateResponse|error - A successful response or an error.
get accounts/[string accountId]/contacts/[string contactId]
function get accounts/[string accountId]/contacts/[string contactId](string? cloud_provider) returns ContactGetResponse|error
Gets one or more contacts.
Parameters
- cloud_provider string? (default ()) - (Optional) The cloud provider from which to retrieve the contacts. Valid values are:
rooms
docusignCore
(default)
Return Type
- ContactGetResponse|error - A successful response or an error.
delete accounts/[string accountId]/contacts/[string contactId]
function delete accounts/[string accountId]/contacts/[string contactId]() returns ContactUpdateResponse|error
Deletes a contact.
Return Type
- ContactUpdateResponse|error - A successful response or an error.
get accounts/[string accountId]/custom_fields
function get accounts/[string accountId]/custom_fields() returns AccountCustomFields|error
Gets a list of custom fields.
Return Type
- AccountCustomFields|error - A successful response or an error.
post accounts/[string accountId]/custom_fields
function post accounts/[string accountId]/custom_fields(CustomField payload, string? apply_to_templates) returns AccountCustomFields|error
Creates an account custom field.
Parameters
- payload CustomField -
- apply_to_templates string? (default ()) - (Optional) When true, the new custom field is applied to all of the templates on the account.
Return Type
- AccountCustomFields|error - A successful response or an error.
put accounts/[string accountId]/custom_fields/[string customFieldId]
function put accounts/[string accountId]/custom_fields/[string customFieldId](CustomField payload, string? apply_to_templates) returns AccountCustomFields|error
Updates an account custom field.
Return Type
- AccountCustomFields|error - A successful response or an error.
delete accounts/[string accountId]/custom_fields/[string customFieldId]
function delete accounts/[string accountId]/custom_fields/[string customFieldId](string? apply_to_templates) returns error?
Deletes an account custom field.
Parameters
- apply_to_templates string? (default ()) -
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/envelopes
function get accounts/[string accountId]/envelopes(string? ac_status, string? block, string? cdse_mode, string? continuation_token, string? count, string? custom_field, string? email, string? envelope_ids, string? exclude, string? folder_ids, string? folder_types, string? from_date, string? from_to_status, string? include, string? include_purge_information, string? intersecting_folder_ids, string? last_queried_date, string? 'order, string? order_by, string? powerformids, string? query_budget, string? requester_date_format, string? search_mode, string? search_text, string? start_position, string? status, string? to_date, string? transaction_ids, string? user_filter, string? user_id, string? user_name) returns EnvelopesInformation|error
Search for specific sets of envelopes by using search filters.
Parameters
- ac_status string? (default ()) - Specifies the Authoritative Copy Status for the envelopes. Valid values: Unknown, Original, Transferred, AuthoritativeCopy, AuthoritativeCopyExportPending, AuthoritativeCopyExported, DepositPending, Deposited, DepositedEO, or DepositFailed.
- block string? (default ()) - Reserved for DocuSign.
- cdse_mode string? (default ()) - Reserved for DocuSign.
- continuation_token string? (default ()) - Reserved for DocuSign.
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip.
- custom_field string? (default ()) - Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format:
custom_envelope_field_name=desired_value
Example: If you have an envelope custom field named "Region" and you want to search for all envelopes where the value is "West" you would use set this parameter toRegion=West
.
- email string? (default ()) - Limit results to envelopes
sent by the account user
with this email address.
user_name
must be given as well, and bothemail
anduser_name
must refer to an existing account user.
- envelope_ids string? (default ()) - Comma separated list of
envelopeId
values.
- exclude string? (default ()) - Excludes information from the response. Enter as a comma-separated list (e.g.,
folders,powerforms
). Valid values are:recipients
powerforms
folders
- folder_ids string? (default ()) - Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder Guids or the following values:
awaiting_my_signature
completed
draft
drafts
expiring_soon
inbox
out_for_signature
recyclebin
sentitems
waiting_for_others
- folder_types string? (default ()) - A comma-separated list of folder types you want to retrieve envelopes from. Valid values are:
normal
inbox
sentitems
draft
templates
- from_date string? (default ()) - Specifies the date and time
to start looking for status changes.
This parameter is required
unless
envelopeIds
ortransactionIds
are set. Although you can use any date format supported by the .NET system library's ['DateTime.Parse()'][msoft] function, DocuSign recommends using [ISO 8601][] format dates with an explicit time zone offset If you do not provide a time zone offset, the method uses the server's time zone. For example, the following dates and times refer to the same instant:2017-05-02T01:44Z
2017-05-01T21:44-04:00
2017-05-01T18:44-07:00
[msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
- from_to_status string? (default ()) - This is the status type checked for in the
from_date
/to_date
period. Ifchanged
is specified, then envelopes that changed status during the period are found. If for example,created
is specified, then envelopes created during the period are found. Default ischanged
. Possible values are: Voided, Changed, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut and Processing.
- include string? (default ()) - Specifies additional information to return about the envelopes.
Use a comma-separated list, such as
folders, recipients
to specify information. Valid values are:custom_fields
: The custom fields associated with the envelope.documents
: The documents associated with the envelope.attachments
: The attachments associated with the envelope.extensions
: Information about the email settings associated with the envelope.folders
: The folders where the envelope exists.recipients
: The recipients associated with the envelope.payment_tabs
: The payment tabs associated with the envelope.
- include_purge_information string? (default ()) - When true, information about envelopes that have been deleted is included in the response.
- intersecting_folder_ids string? (default ()) - A comma-separated list of folders that you want want to get envelopes from. Valid values are:
normal
inbox
sentitems
draft
templates
- last_queried_date string? (default ()) - Returns envelopes that were modified prior to the specified date and time.
Example:
2020-05-09T21:56:12.2500000Z
- 'order string? (default ()) - Returns envelopes in either ascending (
asc
) or descending (desc
) order.
- order_by string? (default ()) - Sorts results according to a specific property. Valid values are:
last_modified
action_required
created
completed
envelope_name
expire
sent
signer_list
status
subject
user_name
status_changed
last_modified
- powerformids string? (default ()) - A comma-separated list of
PowerFormId
values.
- query_budget string? (default ()) - The time in seconds that the query should run before returning data.
- requester_date_format string? (default ()) -
- search_mode string? (default ()) -
- search_text string? (default ()) - Free text search criteria that you can use to filter the list of envelopes that is returned.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
- status string? (default ()) - A comma-separated list of current envelope statuses to included in the response. Possible values are:
completed
created
declined
deleted
delivered
processing
sent
signed
timedout
voided
Theany
value is equivalent to any status.
- to_date string? (default ()) - Specifies the date and time
to stop looking for status changes.
The default is the current date and time.
Although you can use any date format
supported by the .NET system library's
['DateTime.Parse()']msoft] function,
DocuSign recommends
using [ISO 8601][] format dates
with an explicit time zone offset
If you do not provide
a time zone offset,
the method uses the server's time zone.
For example, the following dates and times refer to the same instant:
2017-05-02T01:44Z
2017-05-01T21:44-04:00
2017-05-01T18:44-07:00
[msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
- transaction_ids string? (default ()) - If included in the query string, this is a comma separated list of envelope
transactionId
s. If included in therequest_body
, this is a list of envelopetransactionId
s.Note:
transactionId
s are only valid in the DocuSign system for seven days.
- user_filter string? (default ()) - Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example,
user_filter=sender
.) Valid values are:sender
recipient
recipient_only
- user_id string? (default ()) - The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account access can retrieve envelopes by user_id from the account.
- user_name string? (default ()) - Limit results to envelopes
sent by the account user
with this user name.
email
must be given as well, and bothemail
anduser_name
must refer to an existing account user.
Return Type
- EnvelopesInformation|error - A successful response or an error.
post accounts/[string accountId]/envelopes
function post accounts/[string accountId]/envelopes(EnvelopeDefinition payload, string? cdse_mode, string? change_routing_order, string? completed_documents_only, string? merge_roles_on_draft) returns EnvelopeSummary|error
Creates an envelope.
Parameters
- payload EnvelopeDefinition -
- cdse_mode string? (default ()) - Reserved for DocuSign.
- change_routing_order string? (default ()) - When true, users can define the routing order of recipients while sending documents for signature.
- completed_documents_only string? (default ()) - Reserved for DocuSign.
- merge_roles_on_draft string? (default ()) - When 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 tocreated
.) Note: DocuSign recommends that this parameter should be set to true whenever you create a draft envelope with multiple templates.
Return Type
- EnvelopeSummary|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]
function get accounts/[string accountId]/envelopes/[string envelopeId](string? advanced_update, string? include) returns Envelope|error
Gets the status of a single envelope.
Parameters
- advanced_update string? (default ()) - When true, envelope information can be added or modified.
- include string? (default ()) - Specifies additional information about the envelope to return. Enter a comma-separated list, such as
tabs,recipients
. Valid values are:custom_fields
: The custom fields associated with the envelope.documents
: The documents associated with the envelope.attachments
: The attachments associated with the envelope.extensions
: The email settings associated with the envelope.folders
: The folder where the envelope exists.recipients
: The recipients associated with the envelope.powerform
: The PowerForms associated with the envelope.tabs
: The tabs associated with the envelope.payment_tabs
: The payment tabs associated with the envelope.workflow
: The workflow definition associated with the envelope.
put accounts/[string accountId]/envelopes/[string envelopeId]
function put accounts/[string accountId]/envelopes/[string envelopeId](Envelope payload, string? advanced_update, string? resend_envelope) returns EnvelopeUpdateSummary|error
Send, void, or modify a draft envelope. Purge documents from a completed envelope.
Parameters
- payload Envelope - A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.
- advanced_update string? (default ()) - When true, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.
- resend_envelope string? (default ()) - When true, sends the specified envelope again.
Return Type
- EnvelopeUpdateSummary|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/attachments
function get accounts/[string accountId]/envelopes/[string envelopeId]/attachments() returns EnvelopeAttachmentsResult|error
Returns a list of envelope attachments associated with a specified envelope.
Return Type
- EnvelopeAttachmentsResult|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/attachments
function put accounts/[string accountId]/envelopes/[string envelopeId]/attachments(EnvelopeAttachmentsRequest payload) returns EnvelopeAttachmentsResult|error
Adds one or more envelope attachments to a draft or in-process envelope.
Parameters
- payload EnvelopeAttachmentsRequest -
Return Type
- EnvelopeAttachmentsResult|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/attachments
function delete accounts/[string accountId]/envelopes/[string envelopeId]/attachments(EnvelopeAttachmentsRequest payload) returns EnvelopeAttachmentsResult|error
Deletes one or more envelope attachments from a draft envelope.
Parameters
- payload EnvelopeAttachmentsRequest -
Return Type
- EnvelopeAttachmentsResult|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/attachments/[string attachmentId]
function get accounts/[string accountId]/envelopes/[string envelopeId]/attachments/[string attachmentId]() returns byte[]|error
Retrieves an envelope attachment from an envelope.
Return Type
- byte[]|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/attachments/[string attachmentId]
function put accounts/[string accountId]/envelopes/[string envelopeId]/attachments/[string attachmentId](Attachment payload) returns EnvelopeAttachmentsResult|error
Updates an envelope attachment in a draft or in-process envelope.
Parameters
- payload Attachment -
Return Type
- EnvelopeAttachmentsResult|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/audit_events
function get accounts/[string accountId]/envelopes/[string envelopeId]/audit_events() returns EnvelopeAuditEventResponse|error
Gets the envelope audit events for an envelope.
Return Type
- EnvelopeAuditEventResponse|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/comments/transcript
function get accounts/[string accountId]/envelopes/[string envelopeId]/comments/transcript(string? encoding) returns byte[]|error
Gets a PDF transcript of all of the comments in an envelope.
Parameters
- encoding string? (default ()) - (Optional) The encoding to use for the file.
Return Type
- byte[]|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/custom_fields
function get accounts/[string accountId]/envelopes/[string envelopeId]/custom_fields() returns CustomFieldsEnvelope|error
Gets the custom field information for the specified envelope.
Return Type
- CustomFieldsEnvelope|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/custom_fields
function put accounts/[string accountId]/envelopes/[string envelopeId]/custom_fields(EnvelopeCustomFields payload) returns EnvelopeCustomFields|error
Updates envelope custom fields in an envelope.
Parameters
- payload EnvelopeCustomFields -
Return Type
- EnvelopeCustomFields|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/custom_fields
function post accounts/[string accountId]/envelopes/[string envelopeId]/custom_fields(EnvelopeCustomFields payload) returns EnvelopeCustomFields|error
Creates envelope custom fields for an envelope.
Parameters
- payload EnvelopeCustomFields -
Return Type
- EnvelopeCustomFields|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/custom_fields
function delete accounts/[string accountId]/envelopes/[string envelopeId]/custom_fields(EnvelopeCustomFields payload) returns EnvelopeCustomFields|error
Deletes envelope custom fields for draft and in-process envelopes.
Parameters
- payload EnvelopeCustomFields -
Return Type
- EnvelopeCustomFields|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/docGenFormFields
function get accounts/[string accountId]/envelopes/[string envelopeId]/docGenFormFields() returns DocGenFormFieldResponse|error
Returns form fields for an envelope
Return Type
- DocGenFormFieldResponse|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/docGenFormFields
function put accounts/[string accountId]/envelopes/[string envelopeId]/docGenFormFields(DocGenFormFieldRequest payload, string? update_docgen_formfields_only) returns DocGenFormFieldResponse|error
Updates form fields for an envelope.
Parameters
- payload DocGenFormFieldRequest -
- update_docgen_formfields_only string? (default ()) - When true, only the form fields are updated. When false or omitted, the documents are updated as well.
Return Type
- DocGenFormFieldResponse|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/documents
function get accounts/[string accountId]/envelopes/[string envelopeId]/documents(string? documents_by_userid, string? include_docgen_formfields, string? include_metadata, string? include_tabs, string? recipient_id, string? shared_user_id) returns EnvelopeDocumentsResult|error
Gets a list of documents in an envelope.
Parameters
- documents_by_userid string? (default ()) - When true, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.
- include_docgen_formfields string? (default ()) - Reserved for DocuSign.
- include_metadata string? (default ()) - When true, the response includes metadata that indicates which properties the sender can edit.
- include_tabs string? (default ()) - When true, information about the tabs, including prefill tabs, associated with the documents are included in the response.
- recipient_id string? (default ()) - Allows the sender to retrieve the documents as one of the recipients that they control. The
documents_by_userid
parameter must be set to false for this to work.
- shared_user_id string? (default ()) - The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the DocuSign Admin console).
Return Type
- EnvelopeDocumentsResult|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/documents
function put accounts/[string accountId]/envelopes/[string envelopeId]/documents(EnvelopeDefinition payload) returns EnvelopeDocumentsResult|error
Adds one or more documents to an existing envelope.
Parameters
- payload EnvelopeDefinition -
Return Type
- EnvelopeDocumentsResult|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/documents
function delete accounts/[string accountId]/envelopes/[string envelopeId]/documents(EnvelopeDefinition payload) returns EnvelopeDocumentsResult|error
Deletes documents from a draft envelope.
Parameters
- payload EnvelopeDefinition -
Return Type
- EnvelopeDocumentsResult|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]
function get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId](string? certificate, string? documents_by_userid, string? encoding, string? encrypt, string? language, string? recipient_id, string? shared_user_id, string? show_changes, string? watermark) returns byte[]|error
Retrieves a single document or all documents from an envelope.
Parameters
- certificate string? (default ()) - Used only when the
documentId
parameter is the special keywordcombined
. When true, the certificate of completion is included in the combined PDF file. When false, (the default) the certificate of completion is not included in the combined PDF file.
- documents_by_userid string? (default ()) - When true, allows recipients to get documents by their user id. For example, if a user is included in two different routing orders with different visibilities, using this parameter returns all of the documents from both routing orders.
- encoding string? (default ()) - Reserved for DocuSign.
- encrypt string? (default ()) - When true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign.
- language string? (default ()) - Specifies the language for the Certificate of Completion in the response. The supported languages are: Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).
- recipient_id string? (default ()) - Allows the sender to retrieve the documents as one of the recipients that they control. The
documents_by_userid
parameter must be set to false for this functionality to work.
- shared_user_id string? (default ()) - The ID of a shared user that you want to impersonate in order to retrieve their view of the list of documents. This parameter is used in the context of a shared inbox (i.e., when you share envelopes from one user to another through the DocuSign Admin console).
- show_changes string? (default ()) - When true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red. The account must have the Highlight Data Changes feature enabled.
- watermark string? (default ()) - When true, the account has the watermark feature enabled, and the envelope is not complete, then the watermark for the account is added to the PDF documents. This option can remove the watermark.
Return Type
- byte[]|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]
function put accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId](Request request) returns EnvelopeDocument|error
Adds or replaces a document in an existing envelope.
Parameters
- request Request - Updated document content.
Return Type
- EnvelopeDocument|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/fields
function get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/fields() returns EnvelopeDocumentFields|error
Gets the custom document fields from an existing envelope document.
Return Type
- EnvelopeDocumentFields|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/fields
function put accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/fields(EnvelopeDocumentFields payload) returns EnvelopeDocumentFields|error
Updates existing custom document fields in an existing envelope document.
Parameters
- payload EnvelopeDocumentFields -
Return Type
- EnvelopeDocumentFields|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/fields
function post accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/fields(EnvelopeDocumentFields payload) returns EnvelopeDocumentFields|error
Creates custom document fields in an existing envelope document.
Parameters
- payload EnvelopeDocumentFields -
Return Type
- EnvelopeDocumentFields|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/fields
function delete accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/fields(EnvelopeDocumentFields payload) returns EnvelopeDocumentFields|error
Deletes custom document fields from an existing envelope document.
Parameters
- payload EnvelopeDocumentFields -
Return Type
- EnvelopeDocumentFields|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/html_definitions
function get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/html_definitions() returns DocumentHtmlDefinitionOriginals|error
Retrieves the HTML definition used to generate a dynamically sized responsive document.
Return Type
- DocumentHtmlDefinitionOriginals|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/pages
function get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/pages(string? count, string? dpi, string? max_height, string? max_width, string? nocache, string? show_changes, string? start_position) returns PageImages|error
Returns document page images based on input.
Parameters
- count string? (default ()) - The maximum number of results to return.
- dpi string? (default ()) - The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
- max_height string? (default ()) - Sets the maximum height of the returned images in pixels.
- max_width string? (default ()) - Sets the maximum width of the returned images in pixels.
- nocache string? (default ()) - When true, using cache is disabled and image information is retrieved from a database. True is the default value.
- show_changes string? (default ()) - When true, changes display in the user interface.
- start_position string? (default ()) - The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
Return Type
- PageImages|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/pages/[string pageNumber]
function delete accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/pages/[string pageNumber]() returns error?
Deletes a page from a document in an envelope.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/pages/[string pageNumber]/page_image
function get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/pages/[string pageNumber]/page_image(string? dpi, string? max_height, string? max_width, string? show_changes) returns byte[]|error
Gets a page image from an envelope for display.
Parameters
- dpi string? (default ()) - Sets the dots per inch (DPI) for the returned image.
- max_height string? (default ()) - Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.
- max_width string? (default ()) - Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.
- show_changes string? (default ()) - When true, changes display in the user interface.
Return Type
- byte[]|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/pages/[string pageNumber]/page_image
function put accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/pages/[string pageNumber]/page_image(PageRequest payload) returns error?
Rotates page image from an envelope for display.
Parameters
- payload PageRequest -
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/pages/[string pageNumber]/tabs
function get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/pages/[string pageNumber]/tabs() returns EnvelopeDocumentTabs|error
Returns tabs on the specified page.
Return Type
- EnvelopeDocumentTabs|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/responsive_html_preview
function post accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/responsive_html_preview(DocumentHtmlDefinition payload) returns DocumentHtmlDefinitions|error
Creates a preview of the responsive version of a document.
Parameters
- payload DocumentHtmlDefinition -
Return Type
- DocumentHtmlDefinitions|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/tabs
function get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/tabs(string? include_metadata, string? page_numbers) returns EnvelopeDocumentTabs|error
Returns the tabs on a document.
Parameters
- include_metadata string? (default ()) - When true, the response includes metadata indicating which properties are editable.
- page_numbers string? (default ()) - Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page GUIDs.
Example:
page_numbers=2,6
Note: You can only enter individual page numbers, and not a page range.
Return Type
- EnvelopeDocumentTabs|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/tabs
function put accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/tabs(Tabs payload) returns Tabs|error
Updates the tabs for document.
Parameters
- payload Tabs - A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
post accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/tabs
function post accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/tabs(Tabs payload) returns Tabs|error
Adds tabs to a document in an envelope.
Parameters
- payload Tabs - A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
delete accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/tabs
function delete accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/tabs(Tabs payload) returns Tabs|error
Deletes tabs from a document in an envelope.
Parameters
- payload Tabs - A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.
get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/templates
function get accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/templates(string? include) returns TemplateInformation|error
Gets the templates associated with a document in an existing envelope.
Parameters
- include string? (default ()) - A comma-separated list that limits the results.
Valid values are:
applied
matched
Return Type
- TemplateInformation|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/templates
function post accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/templates(DocumentTemplateList payload, string? preserve_template_recipient) returns DocumentTemplateList|error
Adds templates to a document in an envelope.
Parameters
- payload DocumentTemplateList -
- preserve_template_recipient string? (default ()) - If omitted or set to false (the default), envelope recipients will be removed if the template being applied includes only tabs positioned via anchor text for the recipient, and none of the documents include the anchor text. When true, the recipients will be preserved after the template is applied.
Return Type
- DocumentTemplateList|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/templates/[string templateId]
function delete accounts/[string accountId]/envelopes/[string envelopeId]/documents/[string documentId]/templates/[string templateId]() returns error?
Deletes a template from a document in an existing envelope.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/email_settings
function get accounts/[string accountId]/envelopes/[string envelopeId]/email_settings() returns EmailSettings|error
Gets the email setting overrides for an envelope.
Return Type
- EmailSettings|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/email_settings
function put accounts/[string accountId]/envelopes/[string envelopeId]/email_settings(EmailSettings payload) returns EmailSettings|error
Updates the email setting overrides for an envelope.
Parameters
- payload EmailSettings - A complex type that contains email settings.
Return Type
- EmailSettings|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/email_settings
function post accounts/[string accountId]/envelopes/[string envelopeId]/email_settings(EmailSettings payload) returns EmailSettings|error
Adds email setting overrides to an envelope.
Parameters
- payload EmailSettings - A complex type that contains email settings.
Return Type
- EmailSettings|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/email_settings
function delete accounts/[string accountId]/envelopes/[string envelopeId]/email_settings() returns EmailSettings|error
Deletes the email setting overrides for an envelope.
Return Type
- EmailSettings|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/form_data
function get accounts/[string accountId]/envelopes/[string envelopeId]/form_data() returns EnvelopeFormData|error
Returns envelope tab data for an existing envelope.
Return Type
- EnvelopeFormData|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/html_definitions
function get accounts/[string accountId]/envelopes/[string envelopeId]/html_definitions() returns DocumentHtmlDefinitionOriginals|error
Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.
Return Type
- DocumentHtmlDefinitionOriginals|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/'lock
function get accounts/[string accountId]/envelopes/[string envelopeId]/'lock() returns EnvelopeLocks|error
Gets envelope lock information.
Return Type
- EnvelopeLocks|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/'lock
function put accounts/[string accountId]/envelopes/[string envelopeId]/'lock(LockRequest payload) returns EnvelopeLocks|error
Updates an envelope lock.
Parameters
- payload LockRequest -
Return Type
- EnvelopeLocks|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/'lock
function post accounts/[string accountId]/envelopes/[string envelopeId]/'lock(LockRequest payload) returns EnvelopeLocks|error
Locks an envelope.
Parameters
- payload LockRequest -
Return Type
- EnvelopeLocks|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/'lock
function delete accounts/[string accountId]/envelopes/[string envelopeId]/'lock() returns EnvelopeLocks|error
Deletes an envelope lock.
Return Type
- EnvelopeLocks|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/notification
function get accounts/[string accountId]/envelopes/[string envelopeId]/notification() returns Notification|error
Gets envelope notification information.
Return Type
- Notification|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/notification
function put accounts/[string accountId]/envelopes/[string envelopeId]/notification(EnvelopeNotificationRequest payload) returns Notification|error
Sets envelope notifications for an existing envelope.
Parameters
- payload EnvelopeNotificationRequest -
Return Type
- Notification|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/recipients
function get accounts/[string accountId]/envelopes/[string envelopeId]/recipients(string? include_anchor_tab_locations, string? include_extended, string? include_metadata, string? include_tabs) returns EnvelopeRecipients|error
Gets the status of recipients for an envelope.
Parameters
- include_anchor_tab_locations string? (default ()) - When true and
include_tabs
value is set to true, all tabs with anchor tab properties are included in the response.
- include_extended string? (default ()) - When true, the extended properties are included in the response.
- include_metadata string? (default ()) - Boolean value that specifies whether to include metadata associated with the recipients (for envelopes only, not templates).
- include_tabs string? (default ()) - When true, the tab information associated with the recipient is included in the response.
Return Type
- EnvelopeRecipients|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/recipients
function put accounts/[string accountId]/envelopes/[string envelopeId]/recipients(EnvelopeRecipients payload, string? combine_same_order_recipients, string? offline_signing, string? resend_envelope) returns RecipientsUpdateSummary|error
Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.
Parameters
- payload EnvelopeRecipients -
- combine_same_order_recipients string? (default ()) - When true, recipients are combined or merged with matching recipients. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order.
- offline_signing string? (default ()) - Indicates if offline signing is enabled for the recipient when a network connection is unavailable.
- resend_envelope string? (default ()) - When true, forces the envelope to be resent if it would not be resent otherwise. Ordinarily, if the recipient's routing order is before or the same as the envelope's next recipient, the envelope is not resent. Setting this query parameter to false has no effect and is the same as omitting it altogether.
Return Type
- RecipientsUpdateSummary|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/recipients
function post accounts/[string accountId]/envelopes/[string envelopeId]/recipients(EnvelopeRecipients payload, string? resend_envelope) returns EnvelopeRecipients|error
Adds one or more recipients to an envelope.
Parameters
- payload EnvelopeRecipients -
- resend_envelope string? (default ()) - When true, forces the envelope to be resent if it would not be resent otherwise. Ordinarily, if the recipient's routing order is before or the same as the envelope's next recipient, the envelope is not resent. Setting this query parameter to false has no effect and is the same as omitting it altogether.
Return Type
- EnvelopeRecipients|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/recipients
function delete accounts/[string accountId]/envelopes/[string envelopeId]/recipients(EnvelopeRecipients payload) returns EnvelopeRecipients|error
Deletes recipients from an envelope.
Parameters
- payload EnvelopeRecipients -
Return Type
- EnvelopeRecipients|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]
function delete accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]() returns EnvelopeRecipients|error
Deletes a recipient from an envelope.
Return Type
- EnvelopeRecipients|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/consumer_disclosure
function get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/consumer_disclosure(string? langCode) returns ConsumerDisclosure|error
Gets the default Electronic Record and Signature Disclosure for an envelope.
Parameters
- langCode string? (default ()) - (Optional) The code for the signer language version of the disclosure that you want to retrieve. The following languages are supported:
- Arabic (
ar
) - Bulgarian (
bg
) - Czech (
cs
) - Chinese Simplified (
zh_CN
) - Chinese Traditional (
zh_TW
) - Croatian (
hr
) - Danish (
da
) - Dutch (
nl
) - English US (
en
) - English UK (
en_GB
) - Estonian (
et
) - Farsi (
fa
) - Finnish (
fi
) - French (
fr
) - French Canadian (
fr_CA
) - German (
de
) - Greek (
el
) - Hebrew (
he
) - Hindi (
hi
) - Hungarian (
hu
) - Bahasa Indonesian (
id
) - Italian (
it
) - Japanese (
ja
) - Korean (
ko
) - Latvian (
lv
) - Lithuanian (
lt
) - Bahasa Melayu (
ms
) - Norwegian (
no
) - Polish (
pl
) - Portuguese (
pt
) - Portuguese Brazil (
pt_BR
) - Romanian (
ro
) - Russian (
ru
) - Serbian (
sr
) - Slovak (
sk
) - Slovenian (
sl
) - Spanish (
es
) - Spanish Latin America (
es_MX
) - Swedish (
sv
) - Thai (
th
) - Turkish (
tr
) - Ukrainian (
uk
) - Vietnamese (
vi
) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value tobrowser
.
- Arabic (
Return Type
- ConsumerDisclosure|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/consumer_disclosure/[string languageCode]
function get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/consumer_disclosure/[string languageCode](string? langCode) returns ConsumerDisclosure|error
Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.
Parameters
- langCode string? (default ()) -
Return Type
- ConsumerDisclosure|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/document_visibility
function get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/document_visibility() returns DocumentVisibilityList|error
Returns document visibility for a recipient
Return Type
- DocumentVisibilityList|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/document_visibility
function put accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/document_visibility(DocumentVisibilityList payload) returns DocumentVisibilityList|error
Updates document visibility for a recipient
Parameters
- payload DocumentVisibilityList -
Return Type
- DocumentVisibilityList|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/identity_proof_token
function post accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/identity_proof_token() returns IdEvidenceResourceToken|error
Creates a resource token for a sender to request ID Evidence data.
Return Type
- IdEvidenceResourceToken|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/initials_image
function get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/initials_image(string? include_chrome) returns byte[]|error
Gets the initials image for a user.
Parameters
- include_chrome string? (default ()) - The added line and identifier around the initial image. Note: Older envelopes might only have chromed images. If getting the non-chromed image fails, try getting the chromed image.
Return Type
- byte[]|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/initials_image
function put accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/initials_image() returns error?
Sets the initials image for an accountless signer.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/signature
function get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/signature() returns UserSignature|error
Gets signature information for a signer or sign-in-person recipient.
Return Type
- UserSignature|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/signature_image
function get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/signature_image(string? include_chrome) returns byte[]|error
Retrieve signature image information for a signer/sign-in-person recipient.
Parameters
- include_chrome string? (default ()) - When true, the response includes the chromed version of the signature image.
Return Type
- byte[]|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/signature_image
function put accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/signature_image() returns error?
Sets the signature image for an accountless signer.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/tabs
function get accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/tabs(string? include_anchor_tab_locations, string? include_metadata) returns EnvelopeRecipientTabs|error
Gets the tabs information for a signer or sign-in-person recipient in an envelope.
Parameters
- include_anchor_tab_locations string? (default ()) - When true, all tabs with anchor tab properties are included in the response. The default value is false.
- include_metadata string? (default ()) - When true, the response includes metadata indicating which properties are editable.
Return Type
- EnvelopeRecipientTabs|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/tabs
function put accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/tabs(EnvelopeRecipientTabs payload) returns EnvelopeRecipientTabs|error
Updates the tabs for a recipient.
Parameters
- payload EnvelopeRecipientTabs -
Return Type
- EnvelopeRecipientTabs|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/tabs
function post accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/tabs(EnvelopeRecipientTabs payload) returns EnvelopeRecipientTabs|error
Adds tabs for a recipient.
Parameters
- payload EnvelopeRecipientTabs -
Return Type
- EnvelopeRecipientTabs|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/tabs
function delete accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/tabs(EnvelopeRecipientTabs payload) returns EnvelopeRecipientTabs|error
Deletes the tabs associated with a recipient.
Note: It is an error to delete a tab that has the
templateLocked
property set to true.
This property corresponds to the Restrict changes option in the web app.
Parameters
- payload EnvelopeRecipientTabs -
Return Type
- EnvelopeRecipientTabs|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/views/identity_manual_review
function post accounts/[string accountId]/envelopes/[string envelopeId]/recipients/[string recipientId]/views/identity_manual_review() returns ViewUrl|error
Create the link to the page for manually reviewing IDs.
put accounts/[string accountId]/envelopes/[string envelopeId]/recipients/document_visibility
function put accounts/[string accountId]/envelopes/[string envelopeId]/recipients/document_visibility(DocumentVisibilityList payload) returns DocumentVisibilityList|error
Updates document visibility for recipients
Parameters
- payload DocumentVisibilityList -
Return Type
- DocumentVisibilityList|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/responsive_html_preview
function post accounts/[string accountId]/envelopes/[string envelopeId]/responsive_html_preview(DocumentHtmlDefinition payload) returns DocumentHtmlDefinitions|error
Creates a preview of the responsive versions of all of the documents in an envelope.
Parameters
- payload DocumentHtmlDefinition -
Return Type
- DocumentHtmlDefinitions|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/tabs_blob
function get accounts/[string accountId]/envelopes/[string envelopeId]/tabs_blob() returns error?
Reserved for DocuSign.
Return Type
- error? - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/tabs_blob
function put accounts/[string accountId]/envelopes/[string envelopeId]/tabs_blob() returns error?
Reserved for DocuSign.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/templates
function get accounts/[string accountId]/envelopes/[string envelopeId]/templates(string? include) returns TemplateInformation|error
Get List of Templates used in an Envelope
Parameters
- include string? (default ()) - The possible value is
matching_applied
, which returns template matching information for the template.
Return Type
- TemplateInformation|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/templates
function post accounts/[string accountId]/envelopes/[string envelopeId]/templates(DocumentTemplateList payload, string? preserve_template_recipient) returns DocumentTemplateList|error
Adds templates to an envelope.
Parameters
- payload DocumentTemplateList -
- preserve_template_recipient string? (default ()) - If omitted or set to false (the default), envelope recipients will be removed if the template being applied includes only tabs positioned via anchor text for the recipient, and none of the documents include the anchor text. When true, the recipients will be preserved after the template is applied.
Return Type
- DocumentTemplateList|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/views/correct
function post accounts/[string accountId]/envelopes/[string envelopeId]/views/correct(CorrectViewRequest payload) returns EnvelopeViews|error
Returns a URL to the envelope correction UI.
Parameters
- payload CorrectViewRequest -
Return Type
- EnvelopeViews|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/views/correct
function delete accounts/[string accountId]/envelopes/[string envelopeId]/views/correct(CorrectViewRequest payload) returns error?
Revokes the correction view URL to the Envelope UI.
Parameters
- payload CorrectViewRequest -
Return Type
- error? - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/views/edit
function post accounts/[string accountId]/envelopes/[string envelopeId]/views/edit(ReturnUrlRequest payload) returns EnvelopeViews|error
Returns a URL to the edit view UI.
Parameters
- payload ReturnUrlRequest -
Return Type
- EnvelopeViews|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/views/recipient
function post accounts/[string accountId]/envelopes/[string envelopeId]/views/recipient(RecipientViewRequest payload) returns EnvelopeViews|error
Returns a URL to the recipient view UI.
Parameters
- payload RecipientViewRequest -
Return Type
- EnvelopeViews|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/views/recipient_preview
function post accounts/[string accountId]/envelopes/[string envelopeId]/views/recipient_preview(RecipientPreviewRequest payload) returns ViewUrl|error
Creates an envelope recipient preview.
Parameters
- payload RecipientPreviewRequest -
post accounts/[string accountId]/envelopes/[string envelopeId]/views/sender
function post accounts/[string accountId]/envelopes/[string envelopeId]/views/sender(ReturnUrlRequest payload) returns EnvelopeViews|error
Returns a URL to the sender view UI.
Parameters
- payload ReturnUrlRequest -
Return Type
- EnvelopeViews|error - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/views/shared
function post accounts/[string accountId]/envelopes/[string envelopeId]/views/shared(RecipientViewRequest payload) returns ViewUrl|error
Returns a URL to the shared recipient view UI for an envelope.
Parameters
- payload RecipientViewRequest -
get accounts/[string accountId]/envelopes/[string envelopeId]/workflow
function get accounts/[string accountId]/envelopes/[string envelopeId]/workflow() returns Workflow|error
Returns the workflow definition for an envelope.
put accounts/[string accountId]/envelopes/[string envelopeId]/workflow
function put accounts/[string accountId]/envelopes/[string envelopeId]/workflow(Workflow payload) returns Workflow|error
Updates the workflow definition for an envelope.
Parameters
- payload Workflow -
delete accounts/[string accountId]/envelopes/[string envelopeId]/workflow
function delete accounts/[string accountId]/envelopes/[string envelopeId]/workflow() returns error?
Delete the workflow definition for an envelope.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/workflow/scheduledSending
function get accounts/[string accountId]/envelopes/[string envelopeId]/workflow/scheduledSending() returns ScheduledSending|error
Returns the scheduled sending rules for an envelope's workflow definition.
Return Type
- ScheduledSending|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/workflow/scheduledSending
function put accounts/[string accountId]/envelopes/[string envelopeId]/workflow/scheduledSending(ScheduledSending payload) returns ScheduledSending|error
Updates the scheduled sending rules for an envelope's workflow.
Parameters
- payload ScheduledSending - An object that describes the settings for scheduled sending.
Return Type
- ScheduledSending|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/workflow/scheduledSending
function delete accounts/[string accountId]/envelopes/[string envelopeId]/workflow/scheduledSending() returns error?
Deletes the scheduled sending rules for the envelope's workflow.
Return Type
- error? - A successful response or an error.
post accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps
function post accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps(WorkflowStep payload) returns WorkflowStep|error
Adds a new step to an envelope's workflow.
Parameters
- payload WorkflowStep -
Return Type
- WorkflowStep|error - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]
function get accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]() returns WorkflowStep|error
Returns a specified workflow step for a specified template.
Return Type
- WorkflowStep|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]
function put accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId](WorkflowStep payload) returns WorkflowStep|error
Updates the specified workflow step for an envelope.
Parameters
- payload WorkflowStep -
Return Type
- WorkflowStep|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]
function delete accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]() returns error?
Deletes a workflow step from an envelope's workflow definition.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]/delayedRouting
function get accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]/delayedRouting() returns DelayedRouting|error
Returns the delayed routing rules for an envelope's workflow step definition.
Return Type
- DelayedRouting|error - A successful response or an error.
put accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]/delayedRouting
function put accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]/delayedRouting(DelayedRouting payload) returns DelayedRouting|error
Updates the delayed routing rules for an envelope's workflow step definition.
Parameters
- payload DelayedRouting - A complex element that specifies the delayed routing settings for the workflow step.
Return Type
- DelayedRouting|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]/delayedRouting
function delete accounts/[string accountId]/envelopes/[string envelopeId]/workflow/steps/[string workflowStepId]/delayedRouting() returns error?
Deletes the delayed routing rules for the specified envelope workflow step.
Return Type
- error? - A successful response or an error.
put accounts/[string accountId]/envelopes/status
function put accounts/[string accountId]/envelopes/status(EnvelopeIdsRequest payload, string? ac_status, string? block, string? count, string? email, string? envelope_ids, string? from_date, string? from_to_status, string? start_position, string? status, string? to_date, string? transaction_ids, string? user_name) returns EnvelopesInformation|error
Gets envelope statuses for a set of envelopes.
Parameters
- payload EnvelopeIdsRequest -
- ac_status string? (default ()) - Specifies the Authoritative Copy Status for the envelopes. Valid values:
Unknown
Original
Transferred
AuthoritativeCopy
AuthoritativeCopyExportPending
AuthoritativeCopyExported
DepositPending
Deposited
DepositedEO
DepositFailed
- block string? (default ()) - When true, removes any results that match one of the provided
transaction_ids
.
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip.
- email string? (default ()) - The email address of the sender.
- envelope_ids string? (default ()) - The envelope IDs to include in the results.
The value of this property can be:
- A comma-separated list of envelope IDs
- The special value
request_body
. In this case, the method uses the envelope IDs in the request body.
- from_date string? (default ()) - The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters
envelope_ids
and/ortransaction_Ids
are provided. Note: This parameter must be set to a validDateTime
, orenvelope_ids
and/ortransaction_ids
must be specified.
- from_to_status string? (default ()) - The envelope status that you are checking for. Possible values are:
Changed
(default)Completed
Created
Declined
Deleted
Delivered
Processing
Sent
Signed
TimedOut
Voided
For example, if you specifyChanged
, this method returns a list of envelopes that changed status during thefrom_date
toto_date
time period.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
- status string? (default ()) - A comma-separated list of envelope status to search for. Possible values are:
completed
created
declined
deleted
delivered
processing
sent
signed
template
voided
- to_date string? (default ()) - Optional date/time setting that specifies the last date/time or envelope status changes in the result set. The default value is the time that you call the method.
- transaction_ids string? (default ()) - The transaction IDs to include in the results. Note that transaction IDs are valid for seven days.
The value of this property can be:
- A list of comma-separated transaction IDs
- The special value
request_body
. In this case, this method uses the transaction IDs in the request body.
- user_name string? (default ()) - Limits results to envelopes
sent by the account user
with this user name.
email
must be given as well, and bothemail
anduser_name
must refer to an existing account user.
Return Type
- EnvelopesInformation|error - A successful response or an error.
get accounts/[string accountId]/envelopes/transfer_rules
function get accounts/[string accountId]/envelopes/transfer_rules(string? count, string? start_position) returns EnvelopeTransferRuleInformation|error
Gets envelope transfer rules.
Parameters
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
Return Type
- EnvelopeTransferRuleInformation|error - A successful response or an error.
put accounts/[string accountId]/envelopes/transfer_rules
function put accounts/[string accountId]/envelopes/transfer_rules(EnvelopeTransferRuleInformation payload) returns EnvelopeTransferRuleInformation|error
Changes the status of multiple envelope transfer rules.
Parameters
- payload EnvelopeTransferRuleInformation -
Return Type
- EnvelopeTransferRuleInformation|error - A successful response or an error.
post accounts/[string accountId]/envelopes/transfer_rules
function post accounts/[string accountId]/envelopes/transfer_rules(EnvelopeTransferRuleRequest payload) returns EnvelopeTransferRuleInformation|error
Creates an envelope transfer rule.
Parameters
- payload EnvelopeTransferRuleRequest -
Return Type
- EnvelopeTransferRuleInformation|error - A successful response or an error.
put accounts/[string accountId]/envelopes/transfer_rules/[string envelopeTransferRuleId]
function put accounts/[string accountId]/envelopes/transfer_rules/[string envelopeTransferRuleId](EnvelopeTransferRule payload) returns EnvelopeTransferRule|error
Changes the status of an envelope transfer rule.
Parameters
- payload EnvelopeTransferRule -
Return Type
- EnvelopeTransferRule|error - A successful response or an error.
delete accounts/[string accountId]/envelopes/transfer_rules/[string envelopeTransferRuleId]
function delete accounts/[string accountId]/envelopes/transfer_rules/[string envelopeTransferRuleId]() returns error?
Deletes an envelope transfer rule.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/favorite_templates
function get accounts/[string accountId]/favorite_templates() returns FavoriteTemplatesInfo|error
Retrieves the list of favorite templates for the account.
Return Type
- FavoriteTemplatesInfo|error - A successful response or an error.
put accounts/[string accountId]/favorite_templates
function put accounts/[string accountId]/favorite_templates(FavoriteTemplatesInfo payload) returns FavoriteTemplatesInfo|error
Set one or more templates as account favorites.
Parameters
- payload FavoriteTemplatesInfo -
Return Type
- FavoriteTemplatesInfo|error - A successful response or an error.
delete accounts/[string accountId]/favorite_templates
function delete accounts/[string accountId]/favorite_templates(FavoriteTemplatesInfo payload) returns FavoriteTemplatesInfo|error
Remove one or more templates from the account favorites.
Parameters
- payload FavoriteTemplatesInfo -
Return Type
- FavoriteTemplatesInfo|error - A successful response or an error.
get accounts/[string accountId]/folders
function get accounts/[string accountId]/folders(string? count, string? include, string? include_items, string? start_position, string? sub_folder_depth, string? template, string? user_filter) returns FoldersResponse|error
Returns a list of the account's folders.
Parameters
- count string? (default ()) - The maximum number of results to return.
- include string? (default ()) - A comma-separated list of folder types to include in the response.
Valid values are:
envelope_folders
: Returns a list of envelope folders. (Default)template_folders
: Returns a list of template folders.shared_template_folders
: Returns a list of shared template folders.
- include_items string? (default ()) - Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
The default value is
0
.
- sub_folder_depth string? (default ()) - If missing or any value other than
-1
, the returned list contains only the top-level folders. A value of-1
returns the complete folder hierarchy.
- template string? (default ()) - This parameter is deprecated as of version 2.1. Use
include
instead.
- user_filter string? (default ()) - Narrows down the resulting folder list by the following values:
all
: Returns all templates owned or shared with the user. (default)owned_by_me
: Returns only templates the user owns.shared_with_me
: Returns only templates that are shared with the user.
Return Type
- FoldersResponse|error - A successful response or an error.
get accounts/[string accountId]/folders/[string folderId]
function get accounts/[string accountId]/folders/[string folderId](string? from_date, string? include_items, string? owner_email, string? owner_name, string? search_text, string? start_position, string? status, string? to_date) returns FolderItemsResponse|error
Gets information about items in a specified folder.
Parameters
- from_date string? (default ()) - Reserved for DocuSign.
- include_items string? (default ()) - Indicates whether folder items are included in the response. If this parameter is omitted, the default is false.
- owner_email string? (default ()) - Reserved for DocuSign.
- owner_name string? (default ()) - Reserved for DocuSign.
- search_text string? (default ()) - Reserved for DocuSign.
- start_position string? (default ()) - Reserved for DocuSign.
- status string? (default ()) - Reserved for DocuSign.
- to_date string? (default ()) - Reserved for DocuSign.
Return Type
- FolderItemsResponse|error - A successful response or an error.
put accounts/[string accountId]/folders/[string folderId]
function put accounts/[string accountId]/folders/[string folderId](FoldersRequest payload) returns FoldersResponse|error
Moves a set of envelopes from their current folder to another folder.
Parameters
- payload FoldersRequest -
Return Type
- FoldersResponse|error - A successful response or an error.
get accounts/[string accountId]/groups
function get accounts/[string accountId]/groups(string? count, string? group_type, string? include_usercount, string? search_text, string? start_position) returns GroupInformation|error
Gets information about groups associated with the account.
Parameters
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip. Valid values:1
to100
- group_type string? (default ()) - The type of group to return. Valid values:
AdminGroup
CustomGroup
EveryoneGroup
- include_usercount string? (default ()) - When true, every group returned in the response includes a
userCount
property that contains the total number of users in the group. The default is true.
- search_text string? (default ()) - Filters the results of a GET request based on the text that you specify.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
Return Type
- GroupInformation|error - A successful response or an error.
put accounts/[string accountId]/groups
function put accounts/[string accountId]/groups(GroupInformation payload) returns GroupInformation|error
Updates the group information for a group.
Parameters
- payload GroupInformation -
Return Type
- GroupInformation|error - A successful response or an error.
post accounts/[string accountId]/groups
function post accounts/[string accountId]/groups(GroupInformation payload) returns GroupInformation|error
Creates one or more groups for the account.
Parameters
- payload GroupInformation -
Return Type
- GroupInformation|error - A successful response or an error.
delete accounts/[string accountId]/groups
function delete accounts/[string accountId]/groups(GroupInformation payload) returns GroupInformation|error
Deletes an existing user group.
Parameters
- payload GroupInformation -
Return Type
- GroupInformation|error - A successful response or an error.
get accounts/[string accountId]/groups/[string groupId]/brands
function get accounts/[string accountId]/groups/[string groupId]/brands() returns GroupBrands|error
Gets the brand information for a group.
Return Type
- GroupBrands|error - A successful response or an error.
put accounts/[string accountId]/groups/[string groupId]/brands
function put accounts/[string accountId]/groups/[string groupId]/brands(BrandsRequest payload) returns GroupBrands|error
Adds an existing brand to a group.
Parameters
- payload BrandsRequest -
Return Type
- GroupBrands|error - A successful response or an error.
delete accounts/[string accountId]/groups/[string groupId]/brands
function delete accounts/[string accountId]/groups/[string groupId]/brands(BrandsRequest payload) returns GroupBrands|error
Deletes brand information from a group.
Parameters
- payload BrandsRequest -
Return Type
- GroupBrands|error - A successful response or an error.
get accounts/[string accountId]/groups/[string groupId]/users
function get accounts/[string accountId]/groups/[string groupId]/users(string? count, string? start_position) returns UsersResponse|error
Gets a list of users in a group.
Parameters
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip. Valid values:1
to100
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
Return Type
- UsersResponse|error - A successful response or an error.
put accounts/[string accountId]/groups/[string groupId]/users
function put accounts/[string accountId]/groups/[string groupId]/users(UserInfoList payload) returns UsersResponse|error
Adds one or more users to an existing group.
Parameters
- payload UserInfoList -
Return Type
- UsersResponse|error - A successful response or an error.
delete accounts/[string accountId]/groups/[string groupId]/users
function delete accounts/[string accountId]/groups/[string groupId]/users(UserInfoList payload) returns UsersResponse|error
Deletes one or more users from a group
Parameters
- payload UserInfoList -
Return Type
- UsersResponse|error - A successful response or an error.
get accounts/[string accountId]/identity_verification
function get accounts/[string accountId]/identity_verification(string? identity_verification_workflow_status) returns AccountIdentityVerificationResponse|error
Retrieves the Identity Verification workflows available to an account.
Parameters
- identity_verification_workflow_status string? (default ()) - Filters the workflows returned according to status. Valid values:
active
: Only active workflows are returned. This is the default.deactivated
: Only deactivated workflows are returned.all
: All workflows are returned.
Return Type
- AccountIdentityVerificationResponse|error - A successful response or an error.
get accounts/[string accountId]/payment_gateway_accounts
function get accounts/[string accountId]/payment_gateway_accounts() returns PaymentGatewayAccountsInfo|error
List payment gateway accounts
Return Type
- PaymentGatewayAccountsInfo|error - A successful response or an error.
get accounts/[string accountId]/permission_profiles
function get accounts/[string accountId]/permission_profiles(string? include) returns PermissionProfileInformation|error
Gets a list of permission profiles.
Parameters
- include string? (default ()) - A comma-separated list of additional properties to return in the response. Valid values are:
user_count
: The total number of users associated with the permission profile.closed_users
: Includes closed users in theuser_count
.account_management
: The account management settings.metadata
: Metadata indicating whether the properties associated with the account permission profile are editable. Example:user_count,closed_users
Return Type
- PermissionProfileInformation|error - A successful response or an error.
post accounts/[string accountId]/permission_profiles
function post accounts/[string accountId]/permission_profiles(PermissionProfile payload, string? include) returns PermissionProfile|error
Creates a new permission profile for an account.
Parameters
- payload PermissionProfile -
- include string? (default ()) - 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.
Return Type
- PermissionProfile|error - A successful response or an error.
get accounts/[string accountId]/permission_profiles/[string permissionProfileId]
function get accounts/[string accountId]/permission_profiles/[string permissionProfileId](string? include) returns PermissionProfile|error
Returns a permission profile for an account.
Parameters
- include string? (default ()) - 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.
Return Type
- PermissionProfile|error - A successful response or an error.
put accounts/[string accountId]/permission_profiles/[string permissionProfileId]
function put accounts/[string accountId]/permission_profiles/[string permissionProfileId](PermissionProfile payload, string? include) returns PermissionProfile|error
Updates a permission profile.
Parameters
- payload PermissionProfile -
- include string? (default ()) - 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.
Return Type
- PermissionProfile|error - A successful response or an error.
delete accounts/[string accountId]/permission_profiles/[string permissionProfileId]
function delete accounts/[string accountId]/permission_profiles/[string permissionProfileId](string? move_users_to) returns error?
Deletes a permission profile from an account.
Parameters
- move_users_to string? (default ()) -
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/powerforms
function get accounts/[string accountId]/powerforms(string? from_date, string? 'order, string? order_by, string? search_fields, string? search_text, string? to_date) returns PowerFormsResponse|error
Returns a list of PowerForms.
Parameters
- from_date string? (default ()) - The start date for a date range. Note: If no value is provided, no date filtering is applied.
- 'order string? (default ()) - The order in which to sort the results.
Valid values are:
asc
: Ascending order.desc
: Descending order.
- order_by string? (default ()) - The file attribute to use to sort the results.
Valid values are:
sender
auth
used
remaining
lastused
status
type
templatename
created
- search_fields string? (default ()) - A comma-separated list of additional properties to include in a search.
sender
: Include sender name and email in the search.recipients
: Include recipient names and emails in the search.envelope
: Include envelope information in the search.
- search_text string? (default ()) - Use this parameter to search for specific text.
- to_date string? (default ()) - The end date for a date range. Note: If no value is provided, this property defaults to the current date.
Return Type
- PowerFormsResponse|error - A successful response or an error.
post accounts/[string accountId]/powerforms
Creates a new PowerForm
Parameters
- payload PowerForm - Information about any PowerForms that are included in the envelope.
delete accounts/[string accountId]/powerforms
function delete accounts/[string accountId]/powerforms(PowerFormsRequest payload) returns PowerFormsResponse|error
Deletes one or more PowerForms.
Parameters
- payload PowerFormsRequest -
Return Type
- PowerFormsResponse|error - A successful response or an error.
get accounts/[string accountId]/powerforms/[string powerFormId]
Returns a single PowerForm.
put accounts/[string accountId]/powerforms/[string powerFormId]
function put accounts/[string accountId]/powerforms/[string powerFormId](PowerForm payload) returns PowerForm|error
Updates an existing PowerForm.
Parameters
- payload PowerForm - Information about any PowerForms that are included in the envelope.
delete accounts/[string accountId]/powerforms/[string powerFormId]
function delete accounts/[string accountId]/powerforms/[string powerFormId]() returns error?
Deletes a PowerForm.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/powerforms/[string powerFormId]/form_data
function get accounts/[string accountId]/powerforms/[string powerFormId]/form_data(string? data_layout, string? from_date, string? to_date) returns PowerFormsFormDataResponse|error
Returns the data that users entered in a PowerForm.
Parameters
- data_layout string? (default ()) - The layout in which to return the PowerForm data. Valid values are:
Native
Csv_Classic
Csv_One_Envelope_Per_Line
Xml_Classic
- from_date string? (default ()) - The start date for a date range in UTC DateTime format. Note: If this property is null, no date filtering is applied.
- to_date string? (default ()) - The end date of a date range in UTC DateTime format. The default value is
UtcNow
.
Return Type
- PowerFormsFormDataResponse|error - A successful response or an error.
get accounts/[string accountId]/powerforms/senders
function get accounts/[string accountId]/powerforms/senders(string? start_position) returns PowerFormSendersResponse|error
Gets PowerForm senders.
Parameters
- start_position string? (default ()) - The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
Return Type
- PowerFormSendersResponse|error - A successful response or an error.
get accounts/[string accountId]/recipient_names
function get accounts/[string accountId]/recipient_names(string? email) returns RecipientNamesResponse|error
Gets the recipient names associated with an email address.
Parameters
- email string? (default ()) - (Required) The email address for which you want to retrieve recipient names.
Return Type
- RecipientNamesResponse|error - A successful response or an error.
get accounts/[string accountId]/seals
function get accounts/[string accountId]/seals() returns AccountSealProviders|error
Returns available seals for specified account.
Return Type
- AccountSealProviders|error - A successful response or an error.
get accounts/[string accountId]/search_folders/[string searchFolderId]
function get accounts/[string accountId]/search_folders/[string searchFolderId](string? all, string? count, string? from_date, string? include_recipients, string? 'order, string? order_by, string? start_position, string? to_date) returns FolderItemResponse|error
Deprecated. Use Envelopes: listStatusChanges.
Parameters
- all string? (default ()) - Specifies that all envelopes that match the criteria are returned.
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip. Valid values:1
to100
- from_date string? (default ()) - Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
- include_recipients string? (default ()) - When true, the recipient information is returned in the response.
- 'order string? (default ()) - Specifies the order in which the list is returned. Valid values are:
asc
for ascending order, anddesc
for descending order.
- order_by string? (default ()) - Specifies the property used to sort the list. Valid values are:
action_required
,created
,completed
,sent
,signer_list
,status
, orsubject
.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
- to_date string? (default ()) - Specifies the end of the date range to return.
Return Type
- FolderItemResponse|error - A successful response or an error.
get accounts/[string accountId]/settings
function get accounts/[string accountId]/settings() returns AccountSettingsInformation|error
Gets account settings information.
Return Type
- AccountSettingsInformation|error - A successful response or an error.
put accounts/[string accountId]/settings
function put accounts/[string accountId]/settings(AccountSettingsInformation payload) returns error?
Updates the account settings for an account.
Parameters
- payload AccountSettingsInformation -
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/settings/bcc_email_archives
function get accounts/[string accountId]/settings/bcc_email_archives(string? count, string? start_position) returns BccEmailArchiveList|error
Gets the BCC email archive configurations for an account.
Parameters
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
Return Type
- BccEmailArchiveList|error - A successful response or an error.
post accounts/[string accountId]/settings/bcc_email_archives
function post accounts/[string accountId]/settings/bcc_email_archives(BccEmailArchive payload) returns BccEmailArchive|error
Creates a BCC email archive configuration.
Parameters
- payload BccEmailArchive - Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address.
Return Type
- BccEmailArchive|error - A successful response or an error.
get accounts/[string accountId]/settings/bcc_email_archives/[string bccEmailArchiveId]
function get accounts/[string accountId]/settings/bcc_email_archives/[string bccEmailArchiveId](string? count, string? start_position) returns BccEmailArchiveHistoryList|error
Gets a BCC email archive configuration and its history.
Parameters
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of items to skip.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
Return Type
- BccEmailArchiveHistoryList|error - A successful response or an error.
delete accounts/[string accountId]/settings/bcc_email_archives/[string bccEmailArchiveId]
function delete accounts/[string accountId]/settings/bcc_email_archives/[string bccEmailArchiveId]() returns error?
Deletes a BCC email archive configuration.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/settings/enote_configuration
function get accounts/[string accountId]/settings/enote_configuration() returns ENoteConfiguration|error
Returns the configuration information for the eNote eOriginal integration.
Return Type
- ENoteConfiguration|error - A successful response or an error.
put accounts/[string accountId]/settings/enote_configuration
function put accounts/[string accountId]/settings/enote_configuration(ENoteConfiguration payload) returns ENoteConfiguration|error
Updates configuration information for the eNote eOriginal integration.
Parameters
- payload ENoteConfiguration -
Return Type
- ENoteConfiguration|error - A successful response or an error.
delete accounts/[string accountId]/settings/enote_configuration
function delete accounts/[string accountId]/settings/enote_configuration() returns error?
Deletes configuration information for the eNote eOriginal integration.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/settings/envelope_purge_configuration
function get accounts/[string accountId]/settings/envelope_purge_configuration() returns EnvelopePurgeConfiguration|error
Gets the envelope purge configuration for an account.
Return Type
- EnvelopePurgeConfiguration|error - A successful response or an error.
put accounts/[string accountId]/settings/envelope_purge_configuration
function put accounts/[string accountId]/settings/envelope_purge_configuration(EnvelopePurgeConfiguration payload) returns EnvelopePurgeConfiguration|error
Sets the envelope purge configuration for an account.
Parameters
- payload EnvelopePurgeConfiguration -
Return Type
- EnvelopePurgeConfiguration|error - A successful response or an error.
get accounts/[string accountId]/settings/notification_defaults
function get accounts/[string accountId]/settings/notification_defaults() returns NotificationDefaults|error
Gets envelope notification defaults.
Return Type
- NotificationDefaults|error - A successful response or an error.
put accounts/[string accountId]/settings/notification_defaults
function put accounts/[string accountId]/settings/notification_defaults(NotificationDefaults payload) returns NotificationDefaults|error
Updates envelope notification default settings.
Parameters
- payload NotificationDefaults -
Return Type
- NotificationDefaults|error - A successful response or an error.
get accounts/[string accountId]/settings/password_rules
function get accounts/[string accountId]/settings/password_rules() returns AccountPasswordRules|error
Gets the password rules for an account.
Return Type
- AccountPasswordRules|error - A successful response or an error.
put accounts/[string accountId]/settings/password_rules
function put accounts/[string accountId]/settings/password_rules(AccountPasswordRules payload) returns AccountPasswordRules|error
Updates the password rules for an account.
Parameters
- payload AccountPasswordRules -
Return Type
- AccountPasswordRules|error - A successful response or an error.
get accounts/[string accountId]/settings/tabs
function get accounts/[string accountId]/settings/tabs() returns TabAccountSettings|error
Returns tab settings list for specified account
Return Type
- TabAccountSettings|error - A successful response or an error.
put accounts/[string accountId]/settings/tabs
function put accounts/[string accountId]/settings/tabs(TabAccountSettings payload) returns TabAccountSettings|error
Modifies tab settings for specified account
Parameters
- payload TabAccountSettings - Account-wide tab settings.
Return Type
- TabAccountSettings|error - A successful response or an error.
get accounts/[string accountId]/shared_access
function get accounts/[string accountId]/shared_access(string? count, string? envelopes_not_shared_user_status, string? folder_ids, string? item_type, string? search_text, string? shared, string? start_position, string? user_ids) returns AccountSharedAccess|error
Reserved: Gets the shared item status for one or more users.
Parameters
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip. Default:1000
- envelopes_not_shared_user_status string? (default ()) - This query parameter works in conjunction with
user_ids
. When you specify one of the following user statuses, the query limits the results to only users that match the specified status:ActivationRequired
: Membership Activation requiredActivationSent
: Membership activation sent to userActive
: User Membership is activeClosed
: User Membership is closedDisabled
: User Membership is disabled
- folder_ids string? (default ()) - A comma-separated list of folder IDs for which to return shared item information. If
item_type
is set tofolders
, at least one folder ID is required.
- item_type string? (default ()) - Specifies the type of shared item being requested. Valid values:
envelopes
: Get information about envelope sharing between users.templates
: Get information about template sharing among users and groups.folders
: Get information about folder sharing among users and groups.
- search_text string? (default ()) - Filter user names based on the specified string. The wild-card '*' (asterisk) can be used in the string.
- shared string? (default ()) - A comma-separated list of sharing filters that specifies which users appear in the response.
not_shared
: The response lists users who do not share items ofitem_type
with the current user.shared_to
: The response lists users inuser_list
who are sharing items to current user.shared_from
: The response lists users inuser_list
who are sharing items from the current user.shared_to_and_from
: The response lists users inuser_list
who are sharing items to and from the current user. If the current user does not have administrative privileges, only theshared_to
option is valid.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
- user_ids string? (default ()) - A comma-separated list of user IDs for whom the shared item information is being requested.
Return Type
- AccountSharedAccess|error - A successful response or an error.
put accounts/[string accountId]/shared_access
function put accounts/[string accountId]/shared_access(AccountSharedAccess payload, string? item_type, string? preserve_existing_shared_access, string? user_ids) returns AccountSharedAccess|error
Reserved: Sets the shared access information for users.
Parameters
- payload AccountSharedAccess -
- item_type string? (default ()) - Specifies the type of shared item being set:
envelopes
: Set envelope sharing between users.templates
: Set information about template sharing among users and groups.folders
: Get information about folder sharing among users and groups.
- preserve_existing_shared_access string? (default ()) - When true, preserve the existing shared access settings.
- user_ids string? (default ()) - A comma-separated list of IDs for users whose shared item access is being set.
Return Type
- AccountSharedAccess|error - A successful response or an error.
get accounts/[string accountId]/signatureProviders
function get accounts/[string accountId]/signatureProviders() returns AccountSignatureProviders|error
Gets the available signature providers for an account.
Return Type
- AccountSignatureProviders|error - A successful response or an error.
get accounts/[string accountId]/signatures
function get accounts/[string accountId]/signatures(string? stamp_format, string? stamp_name, string? stamp_type) returns AccountSignaturesInformation|error
Returns a list of stamps available in the account.
Parameters
- stamp_format string? (default ()) - The format of the stamp to return. Valid values:
NameDateHanko
NameHanko
PlaceholderHanko
- stamp_name string? (default ()) - The name associated with the stamps to return. This value can be a Japanese surname (up to 5 characters) or a purchase order ID.
- stamp_type string? (default ()) - The type of the stamps to return. Valid values:
name_stamp
stamp
signature
Return Type
- AccountSignaturesInformation|error - A successful response or an error.
put accounts/[string accountId]/signatures
function put accounts/[string accountId]/signatures(AccountSignaturesInformation payload) returns AccountSignaturesInformation|error
Updates an account stamp.
Parameters
- payload AccountSignaturesInformation -
Return Type
- AccountSignaturesInformation|error - A successful response or an error.
post accounts/[string accountId]/signatures
function post accounts/[string accountId]/signatures(AccountSignaturesInformation payload, string? decode_only) returns AccountSignaturesInformation|error
Adds or updates one or more account stamps.
Return Type
- AccountSignaturesInformation|error - A successful response or an error.
get accounts/[string accountId]/signatures/[string signatureId]
function get accounts/[string accountId]/signatures/[string signatureId]() returns AccountSignature|error
Returns information about the specified stamp.
Return Type
- AccountSignature|error - A successful response or an error.
put accounts/[string accountId]/signatures/[string signatureId]
function put accounts/[string accountId]/signatures/[string signatureId](AccountSignatureDefinition payload, string? close_existing_signature) returns AccountSignature|error
Updates an account stamp by ID.
Parameters
- payload AccountSignatureDefinition -
- close_existing_signature string? (default ()) - When true, closes the current signature.
Return Type
- AccountSignature|error - A successful response or an error.
delete accounts/[string accountId]/signatures/[string signatureId]
function delete accounts/[string accountId]/signatures/[string signatureId]() returns error?
Deletes an account stamp.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/signatures/[string signatureId]/[string imageType]
function get accounts/[string accountId]/signatures/[string signatureId]/[string imageType](string? include_chrome) returns byte[]|error
Returns the image for an account stamp.
Parameters
- include_chrome string? (default ()) - When true, the chrome (or frame containing the added line and identifier) is included with the signature image.
Return Type
- byte[]|error - A successful response or an error.
put accounts/[string accountId]/signatures/[string signatureId]/[string imageType]
function put accounts/[string accountId]/signatures/[string signatureId]/[string imageType](string? transparent_png) returns AccountSignature|error
Sets a signature image, initials, or stamp.
Parameters
- transparent_png string? (default ()) -
Return Type
- AccountSignature|error - A successful response or an error.
delete accounts/[string accountId]/signatures/[string signatureId]/[string imageType]
function delete accounts/[string accountId]/signatures/[string signatureId]/[string imageType]() returns AccountSignature|error
Deletes the image for a stamp.
Return Type
- AccountSignature|error - A successful response or an error.
get accounts/[string accountId]/signing_groups
function get accounts/[string accountId]/signing_groups(string? group_type, string? include_users) returns SigningGroupInformation|error
Gets a list of the Signing Groups in an account.
Parameters
- group_type string? (default ()) - Filters by the type of signing group. Valid values:
sharedSigningGroup
privateSigningGroup
systemSigningGroup
- include_users string? (default ()) - When true, the response includes the signing group members.
Return Type
- SigningGroupInformation|error - A successful response or an error.
put accounts/[string accountId]/signing_groups
function put accounts/[string accountId]/signing_groups(SigningGroupInformation payload) returns SigningGroupInformation|error
Updates signing group names.
Parameters
- payload SigningGroupInformation -
Return Type
- SigningGroupInformation|error - A successful response or an error.
post accounts/[string accountId]/signing_groups
function post accounts/[string accountId]/signing_groups(SigningGroupInformation payload) returns SigningGroupInformation|error
Creates a signing group.
Parameters
- payload SigningGroupInformation -
Return Type
- SigningGroupInformation|error - A successful response or an error.
delete accounts/[string accountId]/signing_groups
function delete accounts/[string accountId]/signing_groups(SigningGroupInformation payload) returns SigningGroupInformation|error
Deletes one or more signing groups.
Parameters
- payload SigningGroupInformation -
Return Type
- SigningGroupInformation|error - A successful response or an error.
get accounts/[string accountId]/signing_groups/[string signingGroupId]
function get accounts/[string accountId]/signing_groups/[string signingGroupId]() returns SigningGroup|error
Gets information about a signing group.
Return Type
- SigningGroup|error - A successful response or an error.
put accounts/[string accountId]/signing_groups/[string signingGroupId]
function put accounts/[string accountId]/signing_groups/[string signingGroupId](SigningGroup payload) returns SigningGroup|error
Updates a signing group.
Parameters
- payload SigningGroup -
Return Type
- SigningGroup|error - A successful response or an error.
get accounts/[string accountId]/signing_groups/[string signingGroupId]/users
function get accounts/[string accountId]/signing_groups/[string signingGroupId]/users() returns SigningGroupUsers|error
Gets a list of members in a Signing Group.
Return Type
- SigningGroupUsers|error - A successful response or an error.
put accounts/[string accountId]/signing_groups/[string signingGroupId]/users
function put accounts/[string accountId]/signing_groups/[string signingGroupId]/users(SigningGroupUsers payload) returns SigningGroupUsers|error
Adds members to a signing group.
Parameters
- payload SigningGroupUsers - A complex type that contains information about users in the signing group.
Return Type
- SigningGroupUsers|error - A successful response or an error.
delete accounts/[string accountId]/signing_groups/[string signingGroupId]/users
function delete accounts/[string accountId]/signing_groups/[string signingGroupId]/users(SigningGroupUsers payload) returns SigningGroupUsers|error
Deletes one or more members from a signing group.
Parameters
- payload SigningGroupUsers - A complex type that contains information about users in the signing group.
Return Type
- SigningGroupUsers|error - A successful response or an error.
get accounts/[string accountId]/supported_languages
function get accounts/[string accountId]/supported_languages() returns SupportedLanguages|error
Gets the supported languages for envelope recipients.
Return Type
- SupportedLanguages|error - A successful response or an error.
get accounts/[string accountId]/tab_definitions
function get accounts/[string accountId]/tab_definitions(string? custom_tab_only) returns TabMetadataList|error
Gets a list of all account tabs.
Parameters
- custom_tab_only string? (default ()) - When true, only custom tabs are returned in the response.
Return Type
- TabMetadataList|error - A successful response or an error.
post accounts/[string accountId]/tab_definitions
function post accounts/[string accountId]/tab_definitions(TabMetadata payload) returns TabMetadata|error
Creates a custom tab.
Parameters
- payload TabMetadata -
Return Type
- TabMetadata|error - A successful response or an error.
get accounts/[string accountId]/tab_definitions/[string customTabId]
function get accounts/[string accountId]/tab_definitions/[string customTabId]() returns TabMetadata|error
Gets custom tab information.
Return Type
- TabMetadata|error - A successful response or an error.
put accounts/[string accountId]/tab_definitions/[string customTabId]
function put accounts/[string accountId]/tab_definitions/[string customTabId](TabMetadata payload) returns TabMetadata|error
Updates custom tab information.
Parameters
- payload TabMetadata -
Return Type
- TabMetadata|error - A successful response or an error.
delete accounts/[string accountId]/tab_definitions/[string customTabId]
function delete accounts/[string accountId]/tab_definitions/[string customTabId]() returns error?
Deletes custom tab information.
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/templates
function get accounts/[string accountId]/templates(string? count, string? created_from_date, string? created_to_date, string? folder_ids, string? folder_types, string? from_date, string? include, string? is_deleted_template_only, string? is_download, string? modified_from_date, string? modified_to_date, string? 'order, string? order_by, string? search_fields, string? search_text, string? shared_by_me, string? start_position, string? template_ids, string? to_date, string? used_from_date, string? used_to_date, string? user_filter, string? user_id) returns EnvelopeTemplateResults|error
Gets the list of templates.
Parameters
- count string? (default ()) - The maximum number of results to return.
Use
start_position
to specify the number of results to skip.
- created_from_date string? (default ()) - Lists templates created on or after this date.
- created_to_date string? (default ()) - Lists templates modified before this date.
- folder_ids string? (default ()) - A comma-separated list of folder ID GUIDs.
- folder_types string? (default ()) - The type of folder to return templates for. Possible values are:
templates
: Templates in the My Templates folder. Templates in the Shared Templates and All Template folders (if the request ID from and Admin) are excluded.templates_root
: Templates in the root level of the My Templates folder, but not in an actual folder. Note that the My Templates folder is not a real folder.recylebin
: Templates that have been deleted.
- from_date string? (default ()) - Start of the search date range. Only returns templates created on or after this date/time. If no value is specified, there is no limit on the earliest date created.
- include string? (default ()) - A comma-separated list
of additional template attributes
to include in the response.
Valid values are:
powerforms
: Includes details about the PowerForms associated with the templates.documents
: Includes information about template documents.folders
: Includes information about the folder that holds the template.favorite_template_status
: Includes the templatefavoritedByMe
property. Note: You can mark a template as a favorite only in eSignature v2.1.advanced_templates
: Includes information about advanced templates.recipients
: Includes information about template recipients.custom_fields
: Includes information about template custom fields.notifications
: Includes information about the notification settings for templates.
- is_deleted_template_only string? (default ()) - When true, retrieves templates that have been permanently deleted. The default is false.
Note: After you delete a template, you can see it in the
Deleted
bin in the UI for 24 hours. After 24 hours, the template is permanently deleted.
- is_download string? (default ()) - When true, downloads the templates listed in
template_ids
as a collection of JSON definitions in a single zip file. TheContent-Disposition
header is set in the response. The value of the header provides the filename of the file. The default is false. Note: This parameter only works when you specify a list of templates in thetemplate_ids
parameter.
- modified_from_date string? (default ()) - Lists templates modified on or after this date.
- modified_to_date string? (default ()) - Lists templates modified before this date.
- 'order string? (default ()) - Specifies the sort order of the search results.
Valid values are:
asc
: Ascending (A to Z)desc
: Descending (Z to A)
- order_by string? (default ()) - Specifies how the search results are listed.
Valid values are:
name
: template namemodified
: date/time template was last modifiedused
: date/time the template was last used.
- search_fields string? (default ()) - A comma-separated list of additional template properties to search.
sender
: Include sender name and email in the search.recipients
: Include recipient names and emails in the search.envelope
: Not used in template searches.
- search_text string? (default ()) - The text to use to search the names of templates. Limit: 48 characters.
- shared_by_me string? (default ()) - When true, the response only includes templates shared by the user. When false, the response only returns template not shared by the user. If not specified, templates are returned whether or not they have been shared by the user.
- start_position string? (default ()) - The zero-based index of the
result from which to start returning results.
Use with
count
to limit the number of results. The default value is0
.
- template_ids string? (default ()) - A comma-separated list of template IDs to download. This value is valid only when
is_download
is true.
- to_date string? (default ()) - The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. Note: If this property is null, the value defaults to the current date.
- used_from_date string? (default ()) - Start of the search date range. Only returns templates used or edited on or after this date/time. If no value is specified, there is no limit on the earliest date used.
- used_to_date string? (default ()) - End of the search date range. Only returns templates used or edited up to this date/time. If no value is provided, this defaults to the current date.
- user_filter string? (default ()) - Filters the templates in the response. Valid values are:
owned_by_me
: Results include only templates owned by the user.shared_with_me
: Results include only templates shared with the user.all
: Results include all templates owned or shared with the user.
- user_id string? (default ()) - The ID of the user.
Return Type
- EnvelopeTemplateResults|error - A successful response or an error.
post accounts/[string accountId]/templates
function post accounts/[string accountId]/templates(EnvelopeTemplate payload) returns TemplateSummary|error
Creates one or more templates.
Parameters
- payload EnvelopeTemplate -
Return Type
- TemplateSummary|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]
function get accounts/[string accountId]/templates/[string templateId](string? include) returns EnvelopeTemplate|error
Gets a specific template associated with a specified account.
Parameters
- include string? (default ()) - A comma-separated list
of additional template attributes
to include in the response.
Valid values are:
powerforms
: Includes information about PowerForms.tabs
: Includes information about tabs.documents
: Includes information about documents.favorite_template_status
: : Includes the templatefavoritedByMe
property in the response. Note: You can mark a template as a favorite only in eSignature v2.1.
Return Type
- EnvelopeTemplate|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]
function put accounts/[string accountId]/templates/[string templateId](EnvelopeTemplate payload) returns TemplateUpdateSummary|error
Updates an existing template.
Parameters
- payload EnvelopeTemplate -
Return Type
- TemplateUpdateSummary|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/[string templatePart]
function put accounts/[string accountId]/templates/[string templateId]/[string templatePart](GroupInformation payload) returns GroupInformation|error
Shares a template with a group.
Parameters
- payload GroupInformation -
Return Type
- GroupInformation|error - A successful response or an error.
delete accounts/[string accountId]/templates/[string templateId]/[string templatePart]
function delete accounts/[string accountId]/templates/[string templateId]/[string templatePart](GroupInformation payload) returns GroupInformation|error
Removes a member group's sharing permissions for a template.
Parameters
- payload GroupInformation -
Return Type
- GroupInformation|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/custom_fields
function get accounts/[string accountId]/templates/[string templateId]/custom_fields() returns CustomFields|error
Gets the custom document fields from a template.
Return Type
- CustomFields|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/custom_fields
function put accounts/[string accountId]/templates/[string templateId]/custom_fields(TemplateCustomFields payload) returns CustomFields|error
Updates envelope custom fields in a template.
Parameters
- payload TemplateCustomFields -
Return Type
- CustomFields|error - A successful response or an error.
post accounts/[string accountId]/templates/[string templateId]/custom_fields
function post accounts/[string accountId]/templates/[string templateId]/custom_fields(TemplateCustomFields payload) returns CustomFields|error
Creates custom document fields in an existing template document.
Parameters
- payload TemplateCustomFields -
Return Type
- CustomFields|error - A successful response or an error.
delete accounts/[string accountId]/templates/[string templateId]/custom_fields
function delete accounts/[string accountId]/templates/[string templateId]/custom_fields(TemplateCustomFields payload) returns CustomFields|error
Deletes envelope custom fields in a template.
Parameters
- payload TemplateCustomFields -
Return Type
- CustomFields|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/documents
function get accounts/[string accountId]/templates/[string templateId]/documents(string? include_tabs) returns TemplateDocumentsResult|error
Gets a list of documents associated with a template.
Parameters
- include_tabs string? (default ()) - Reserved for DocuSign.
Return Type
- TemplateDocumentsResult|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/documents
function put accounts/[string accountId]/templates/[string templateId]/documents(EnvelopeDefinition payload) returns TemplateDocumentsResult|error
Adds documents to a template document.
Parameters
- payload EnvelopeDefinition -
Return Type
- TemplateDocumentsResult|error - A successful response or an error.
delete accounts/[string accountId]/templates/[string templateId]/documents
function delete accounts/[string accountId]/templates/[string templateId]/documents(EnvelopeDefinition payload) returns TemplateDocumentsResult|error
Deletes documents from a template.
Parameters
- payload EnvelopeDefinition -
Return Type
- TemplateDocumentsResult|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]
function get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId](string? encrypt, string? file_type, string? show_changes) returns byte[]|error
Gets PDF documents from a template.
Parameters
- encrypt string? (default ()) - When true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. You can decrypt the documents by using the Key Manager DecryptDocument API method. For more information about Key Manager, see the DocuSign Security Appliance Installation Guide that your organization received from DocuSign.
- file_type string? (default ()) -
- show_changes string? (default ()) - When true, any document fields that a recipient changed are highlighted in yellow in the returned PDF document, and optional signatures or initials are outlined in red.
Return Type
- byte[]|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]
function put accounts/[string accountId]/templates/[string templateId]/documents/[string documentId](EnvelopeDefinition payload, string? is_envelope_definition) returns EnvelopeDocument|error
Updates a template document.
Return Type
- EnvelopeDocument|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/fields
function get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/fields() returns DocumentFieldsInformation|error
Gets the custom document fields for a an existing template document.
Return Type
- DocumentFieldsInformation|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/fields
function put accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/fields(DocumentFieldsInformation payload) returns DocumentFieldsInformation|error
Updates existing custom document fields in an existing template document.
Parameters
- payload DocumentFieldsInformation -
Return Type
- DocumentFieldsInformation|error - A successful response or an error.
post accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/fields
function post accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/fields(DocumentFieldsInformation payload) returns DocumentFieldsInformation|error
Creates custom document fields in an existing template document.
Parameters
- payload DocumentFieldsInformation -
Return Type
- DocumentFieldsInformation|error - A successful response or an error.
delete accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/fields
function delete accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/fields(DocumentFieldsInformation payload) returns DocumentFieldsInformation|error
Deletes custom document fields from an existing template document.
Parameters
- payload DocumentFieldsInformation -
Return Type
- DocumentFieldsInformation|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/html_definitions
function get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/html_definitions() returns DocumentHtmlDefinitionOriginals|error
Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.
Return Type
- DocumentHtmlDefinitionOriginals|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/pages
function get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/pages(string? count, string? dpi, string? max_height, string? max_width, string? nocache, string? show_changes, string? start_position) returns PageImages|error
Returns document page images based on input.
Parameters
- count string? (default ()) - The maximum number of results to return.
- dpi string? (default ()) - The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
- max_height string? (default ()) - Sets the maximum height of the returned images in pixels.
- max_width string? (default ()) - Sets the maximum width of the returned images in pixels.
- nocache string? (default ()) - When true, using cache is disabled and image information is retrieved from a database. True is the default value.
- show_changes string? (default ()) - When true, changes display in the user interface.
- start_position string? (default ()) - The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
Return Type
- PageImages|error - A successful response or an error.
delete accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/pages/[string pageNumber]
function delete accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/pages/[string pageNumber](PageRequest payload) returns error?
Deletes a page from a document in an template.
Parameters
- payload PageRequest -
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/pages/[string pageNumber]/page_image
function get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/pages/[string pageNumber]/page_image(string? dpi, string? max_height, string? max_width, string? show_changes) returns byte[]|error
Gets a page image from a template for display.
Parameters
- dpi string? (default ()) - The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
- max_height string? (default ()) - Sets the maximum height of the returned images in pixels.
- max_width string? (default ()) - Sets the maximum width of the returned images in pixels.
- show_changes string? (default ()) -
Return Type
- byte[]|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/pages/[string pageNumber]/page_image
function put accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/pages/[string pageNumber]/page_image(PageRequest payload) returns error?
Rotates page image from a template for display.
Parameters
- payload PageRequest -
Return Type
- error? - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/pages/[string pageNumber]/tabs
function get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/pages/[string pageNumber]/tabs() returns TemplateDocumentTabs|error
Returns tabs on the specified page.
Return Type
- TemplateDocumentTabs|error - A successful response or an error.
post accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/responsive_html_preview
function post accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/responsive_html_preview(DocumentHtmlDefinition payload) returns DocumentHtmlDefinitions|error
Creates a preview of the responsive version of a template document.
Parameters
- payload DocumentHtmlDefinition -
Return Type
- DocumentHtmlDefinitions|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/tabs
function get accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/tabs(string? page_numbers) returns TemplateDocumentTabs|error
Returns tabs on a template.
Parameters
- page_numbers string? (default ()) - Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids.
Example:
page_numbers=2,6
Return Type
- TemplateDocumentTabs|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/tabs
function put accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/tabs(TemplateTabs payload) returns Tabs|error
Updates the tabs for a template.
Parameters
- payload TemplateTabs -
post accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/tabs
function post accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/tabs(TemplateTabs payload) returns Tabs|error
Adds tabs to a document in a template.
Parameters
- payload TemplateTabs -
delete accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/tabs
function delete accounts/[string accountId]/templates/[string templateId]/documents/[string documentId]/tabs(TemplateTabs payload) returns Tabs|error
Deletes tabs from a template.
Parameters
- payload TemplateTabs -
get accounts/[string accountId]/templates/[string templateId]/html_definitions
function get accounts/[string accountId]/templates/[string templateId]/html_definitions() returns DocumentHtmlDefinitionOriginals|error
Gets the Original HTML Definition used to generate the Responsive HTML for the template.
Return Type
- DocumentHtmlDefinitionOriginals|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/'lock
function get accounts/[string accountId]/templates/[string templateId]/'lock() returns LockInformation|error
Gets template lock information.
Return Type
- LockInformation|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/'lock
function put accounts/[string accountId]/templates/[string templateId]/'lock(LockRequest payload) returns LockInformation|error
Updates a template lock.
Parameters
- payload LockRequest -
Return Type
- LockInformation|error - A successful response or an error.
post accounts/[string accountId]/templates/[string templateId]/'lock
function post accounts/[string accountId]/templates/[string templateId]/'lock(LockRequest payload) returns LockInformation|error
Locks a template.
Parameters
- payload LockRequest -
Return Type
- LockInformation|error - A successful response or an error.
delete accounts/[string accountId]/templates/[string templateId]/'lock
function delete accounts/[string accountId]/templates/[string templateId]/'lock(LockRequest payload) returns LockInformation|error
Deletes a template lock.
Parameters
- payload LockRequest -
Return Type
- LockInformation|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/notification
function get accounts/[string accountId]/templates/[string templateId]/notification() returns Notification|error
Gets template notification information.
Return Type
- Notification|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/notification
function put accounts/[string accountId]/templates/[string templateId]/notification(TemplateNotificationRequest payload) returns Notification|error
Updates the notification structure for an existing template.
Parameters
- payload TemplateNotificationRequest -
Return Type
- Notification|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/recipients
function get accounts/[string accountId]/templates/[string templateId]/recipients(string? include_anchor_tab_locations, string? include_extended, string? include_tabs) returns Recipients|error
Gets recipient information from a template.
Parameters
- include_anchor_tab_locations string? (default ()) - When true and
include_tabs
is set to true, all tabs with anchor tab properties are included in the response.
- include_extended string? (default ()) - When true, the extended properties are included in the response.
- include_tabs string? (default ()) - When true, the tab information associated with the recipient is included in the response.
Return Type
- Recipients|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/recipients
function put accounts/[string accountId]/templates/[string templateId]/recipients(TemplateRecipients payload, string? resend_envelope) returns RecipientsUpdateSummary|error
Updates recipients in a template.
Parameters
- payload TemplateRecipients -
- resend_envelope string? (default ()) - When true, resends the envelope to the recipients that you specify in the request body. 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.
Return Type
- RecipientsUpdateSummary|error - A successful response or an error.
post accounts/[string accountId]/templates/[string templateId]/recipients
function post accounts/[string accountId]/templates/[string templateId]/recipients(TemplateRecipients payload, string? resend_envelope) returns Recipients|error
Adds tabs for a recipient.
Parameters
- payload TemplateRecipients -
- resend_envelope string? (default ()) - When true, resends the envelope to the recipients that you specify in the request body. 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.
Return Type
- Recipients|error - A successful response or an error.
delete accounts/[string accountId]/templates/[string templateId]/recipients
function delete accounts/[string accountId]/templates/[string templateId]/recipients(TemplateRecipients payload) returns Recipients|error
Deletes recipients from a template.
Parameters
- payload TemplateRecipients -
Return Type
- Recipients|error - A successful response or an error.
delete accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]
function delete accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId](TemplateRecipients payload) returns Recipients|error
Deletes the specified recipient file from a template.
Parameters
- payload TemplateRecipients -
Return Type
- Recipients|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/document_visibility
function get accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/document_visibility() returns DocumentVisibilityList|error
Returns document visibility for a template recipient
Return Type
- DocumentVisibilityList|error - A successful response or an error.
put accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/document_visibility
function put accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/document_visibility(TemplateDocumentVisibilityList payload) returns TemplateDocumentVisibilityList|error
Updates document visibility for a template recipient
Parameters
- payload TemplateDocumentVisibilityList -
Return Type
- TemplateDocumentVisibilityList|error - A successful response or an error.
get accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/tabs
function get accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/tabs(string? include_anchor_tab_locations, string? include_metadata) returns Tabs|error
Gets the tabs information for a signer or sign-in-person recipient in a template.
Parameters
- include_anchor_tab_locations string? (default ()) - When true, all tabs with anchor tab properties are included in the response. The default value is false.
- include_metadata string? (default ()) - When true, the response includes metadata indicating which properties are editable.
put accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/tabs
function put accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/tabs(TemplateTabs payload) returns Tabs|error
Updates the tabs for a recipient.
Parameters
- payload TemplateTabs -
post accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/tabs
function post accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/tabs(TemplateTabs payload) returns Tabs|error
Adds tabs for a recipient.
Parameters
- payload TemplateTabs -
delete accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/tabs
function delete accounts/[string accountId]/templates/[string templateId]/recipients/[string recipientId]/tabs(TemplateTabs payload) returns Tabs|error
Deletes the tabs associated with a recipient in a template.
Parameters
- payload TemplateTabs -
Return Type
- Tabs|