View Source DocuSign.Api.Accounts (DocuSign v1.2.0)
API calls for all endpoints tagged Accounts
.
Summary
Functions
Deletes the specified account. This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
Retrieves the account information for the specified account. Retrieves the account information for the specified account.
Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account.
Creates new accounts.
Creates new DocuSign accounts. You can use this method to create a single account or up to 100 accounts at a time. Note: This method is restricted to partner integrations. You must work with DocuSign Professional Services or DocuSign Business Development, who will provide you with the Distributor Code and Distributor Password that you need to include in the request body. When creating a single account, the body of the request is a [newAccountRequest
][newAccountRequest] object. Example: { "newAccountRequest": [ { "accountName":"Test Account", "distributorCode":"MY_DIST_CODE", "distributorPassword":"MY_DIST_PWD", "initialUser":{ "email":"user@emaildomain.com", "firstName":"John", "middleName": "Harry", "lastName":"Doe", "suffixName": "", "userName": "John Doe", "jobTitle": "Engineer", "company": "Test Company" }, "addressInformation":{ "address1": "1234 Main Street", "address2": "Suite 100", "city": "Seattle", "state": "WA", "postalCode": "98101", "country": "US", "phone": "1234567890", "fax": "1234567891" }, "planInformation":{ "planId":"37085696-xxxx-xxxx-xxxx-7ea067752959" }, "referralInformation":{ "includedSeats": "1", "referralCode": "code", "referrerName": "name" } } ] }
If the request succeeds, it returns a 201 (Created) HTTP response code. The response returns the new account ID, password, and the default user information for each newly created account. When creating multiple accounts, the body of the request is a newAccountRequests
object, which contains one or more [newAccountDefinition
][newAccountDefinition] objects. You can create up to 100 new accounts at a time this way. The body for a multi-account creation request looks like this in JSON: { "newAccountRequests": [ { "accountName": "accountone", . . . }, { "accountName": "accounttwo", . . . } ] }
A multi-account request looks like this in XML: <newAccountsDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi"> <newAccountRequests> <newAccountDefinition> . . . </newAccountDefinition> <newAccountDefinition> . . . </newAccountDefinition> </newAccountRequests> </newAccountsDefinition>
A multi-account creation request may succeed (report a 201 code) even if some accounts could not be created. In this case, the errorDetails
property in the response contains specific information about the failure. [newAccountDefinition]: #/definitions/newAccountDefinition [nameValue]: #/definitions/nameValue [newAccountRequest]: #/definitions/newAccountRequest
Gets list of recurring and usage charges for the account. Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator
Deletes the signature for one or more captive recipient records. This method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.
Gets the envelope purge configuration for an account.
An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays
). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.
Sets the envelope purge configuration for an account.
An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays
). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes.
Gets envelope notification defaults. This method returns the default settings for the email notifications that signers and senders receive about envelopes.
Updates envelope notification default settings. This method changes the default settings for the email notifications that signers and senders receive about envelopes.
Gets the recipient names associated with an email address. Retrieves a list of all of the names associated with the email address that you pass in. This list can include variants of a single recipient's name that are used for signing, as well as the names of multiple different recipients.
Gets account settings information. Retrieves the account settings information for the specified account.
Updates the account settings for an account.
Updates the account settings for the specified account. Although the request body for this method is a complete accountSettingsInformation
object, you only need to provide the properties that you are updating.
Reserved: Gets the shared item status for one or more users.
Retrieves shared item status for one or more users and types of items. Users with account administration privileges can retrieve shared access information for all account users. Users without account administrator privileges can only retrieve shared access information for themselves, and the returned information is limited to retrieving the status of the members of the account that are sharing their folders to the user. This is equivalent to setting the shared
parameter to shared_from
.
Reserved: Sets the shared access information for users.
This sets the shared access status for one or more users or templates. When setting user shared access, only users with account administration privileges can set shared access status for envelopes. When setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates. Changes to the shared items status are not additive. The change always replaces the current status. To change template shared access, add the query parameter item_type
= templates
to the request. When this is set, the user and envelopes properties are not required. Note: This functionality is a newer version of the Update Group Share functionality.
Gets the supported languages for envelope recipients.
Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the emailBody
and emailSubject
of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages.
Gets a list of unsupported file types. Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.
Functions
@spec accounts_delete_account(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Deletes the specified account. This closes the specified account. You must be an account admin to close your account. Once closed, an account must be reopened by DocuSign.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
@spec accounts_get_account(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.AccountInformation.t()} | {:error, Tesla.Env.t()}
Retrieves the account information for the specified account. Retrieves the account information for the specified account.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters:include_account_settings
(String.t): When true, includes account settings in the response. The default value is false.
Returns
{:ok, DocuSign.Model.AccountInformation.t}
on success{:error, Tesla.Env.t}
on failure
@spec accounts_get_provisioning( Tesla.Env.client(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.ProvisioningInformation.t()} | {:error, Tesla.Env.t()}
Retrieves the account provisioning information for the account. Retrieves the account provisioning information for the account.
Parameters
connection
(DocuSign.Connection): Connection to serveropts
(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.ProvisioningInformation.t}
on success{:error, Tesla.Env.t}
on failure
@spec accounts_post_accounts( Tesla.Env.client(), keyword() ) :: {:ok, DocuSign.Model.NewAccountSummary.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Creates new accounts.
Creates new DocuSign accounts. You can use this method to create a single account or up to 100 accounts at a time. Note: This method is restricted to partner integrations. You must work with DocuSign Professional Services or DocuSign Business Development, who will provide you with the Distributor Code and Distributor Password that you need to include in the request body. When creating a single account, the body of the request is a [newAccountRequest
][newAccountRequest] object. Example: { "newAccountRequest": [ { "accountName":"Test Account", "distributorCode":"MY_DIST_CODE", "distributorPassword":"MY_DIST_PWD", "initialUser":{ "email":"user@emaildomain.com", "firstName":"John", "middleName": "Harry", "lastName":"Doe", "suffixName": "", "userName": "John Doe", "jobTitle": "Engineer", "company": "Test Company" }, "addressInformation":{ "address1": "1234 Main Street", "address2": "Suite 100", "city": "Seattle", "state": "WA", "postalCode": "98101", "country": "US", "phone": "1234567890", "fax": "1234567891" }, "planInformation":{ "planId":"37085696-xxxx-xxxx-xxxx-7ea067752959" }, "referralInformation":{ "includedSeats": "1", "referralCode": "code", "referrerName": "name" } } ] }
If the request succeeds, it returns a 201 (Created) HTTP response code. The response returns the new account ID, password, and the default user information for each newly created account. When creating multiple accounts, the body of the request is a newAccountRequests
object, which contains one or more [newAccountDefinition
][newAccountDefinition] objects. You can create up to 100 new accounts at a time this way. The body for a multi-account creation request looks like this in JSON: { "newAccountRequests": [ { "accountName": "accountone", . . . }, { "accountName": "accounttwo", . . . } ] }
A multi-account request looks like this in XML: <newAccountsDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi"> <newAccountRequests> <newAccountDefinition> . . . </newAccountDefinition> <newAccountDefinition> . . . </newAccountDefinition> </newAccountRequests> </newAccountsDefinition>
A multi-account creation request may succeed (report a 201 code) even if some accounts could not be created. In this case, the errorDetails
property in the response contains specific information about the failure. [newAccountDefinition]: #/definitions/newAccountDefinition [nameValue]: #/definitions/nameValue [newAccountRequest]: #/definitions/newAccountRequest
Parameters
connection
(DocuSign.Connection): Connection to serveropts
(keyword): Optional parameters:body
(NewAccountDefinition):
Returns
{:ok, DocuSign.Model.NewAccountSummary.t}
on success{:error, Tesla.Env.t}
on failure
billing_charges_get_account_billing_charges(connection, account_id, opts \\ [])
View Source@spec billing_charges_get_account_billing_charges( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, DocuSign.Model.BillingChargeResponse.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Gets list of recurring and usage charges for the account. Retrieves the list of recurring and usage charges for the account. This can be used to determine the charge structure and usage of charge plan items. Privileges required: account administrator
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters:include_charges
(String.t): Specifies which billing charges to return. Valid values are: envelopes seats
Returns
{:ok, DocuSign.Model.BillingChargeResponse.t}
on success{:error, Tesla.Env.t}
on failure
captive_recipients_delete_captive_recipients_part(connection, account_id, recipient_part, opts \\ [])
View Source@spec captive_recipients_delete_captive_recipients_part( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.CaptiveRecipientInformation.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Deletes the signature for one or more captive recipient records. This method deletes the signature for one or more captive recipient records. It is primarily used for testing. This functionality provides a way to reset the signature associated with a client user ID so that a new signature can be created the next time the client user ID is used.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.recipient_part
(String.t): Signature is the only supported value.opts
(keyword): Optional parameters:body
(CaptiveRecipientInformation):
Returns
{:ok, DocuSign.Model.CaptiveRecipientInformation.t}
on success{:error, Tesla.Env.t}
on failure
envelope_purge_configuration_get_envelope_purge_configuration(connection, account_id, opts \\ [])
View Source@spec envelope_purge_configuration_get_envelope_purge_configuration( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, DocuSign.Model.EnvelopePurgeConfiguration.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Gets the envelope purge configuration for an account.
An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays
). This method retrieves the current envelope purge configuration for your account. Note: To use this method, you must be an account administrator.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.EnvelopePurgeConfiguration.t}
on success{:error, Tesla.Env.t}
on failure
envelope_purge_configuration_put_envelope_purge_configuration(connection, account_id, opts \\ [])
View Source@spec envelope_purge_configuration_put_envelope_purge_configuration( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, DocuSign.Model.EnvelopePurgeConfiguration.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Sets the envelope purge configuration for an account.
An envelope purge configuration enables account administrators to permanently remove documents and their field data from completed and voided envelopes after a specified retention period (retentionDays
). This method sets the envelope purge configuration for your account. Note: To use this method, you must be an account administrator. For more information, see Purge Envelopes.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters:body
(EnvelopePurgeConfiguration):
Returns
{:ok, DocuSign.Model.EnvelopePurgeConfiguration.t}
on success{:error, Tesla.Env.t}
on failure
notification_defaults_get_notification_defaults(connection, account_id, opts \\ [])
View Source@spec notification_defaults_get_notification_defaults( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, DocuSign.Model.NotificationDefaults.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Gets envelope notification defaults. This method returns the default settings for the email notifications that signers and senders receive about envelopes.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.NotificationDefaults.t}
on success{:error, Tesla.Env.t}
on failure
notification_defaults_put_notification_defaults(connection, account_id, opts \\ [])
View Source@spec notification_defaults_put_notification_defaults( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, DocuSign.Model.NotificationDefaults.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Updates envelope notification default settings. This method changes the default settings for the email notifications that signers and senders receive about envelopes.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters:body
(NotificationDefaults):
Returns
{:ok, DocuSign.Model.NotificationDefaults.t}
on success{:error, Tesla.Env.t}
on failure
recipient_names_get_recipient_names(connection, account_id, opts \\ [])
View Source@spec recipient_names_get_recipient_names(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.RecipientNamesResponse.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Gets the recipient names associated with an email address. Retrieves a list of all of the names associated with the email address that you pass in. This list can include variants of a single recipient's name that are used for signing, as well as the names of multiple different recipients.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): (Required) The external account number (int) or account ID GUID.opts
(keyword): Optional parameters:email
(String.t): The email address for which you want to retrieve recipient names.
Returns
{:ok, DocuSign.Model.RecipientNamesResponse.t}
on success{:error, Tesla.Env.t}
on failure
@spec settings_get_settings(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.AccountSettingsInformation.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Gets account settings information. Retrieves the account settings information for the specified account.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.AccountSettingsInformation.t}
on success{:error, Tesla.Env.t}
on failure
@spec settings_put_settings(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Updates the account settings for an account.
Updates the account settings for the specified account. Although the request body for this method is a complete accountSettingsInformation
object, you only need to provide the properties that you are updating.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters:body
(AccountSettingsInformation):
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
supported_languages_get_supported_languages(connection, account_id, opts \\ [])
View Source@spec supported_languages_get_supported_languages( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, DocuSign.Model.ErrorDetails.t()} | {:ok, DocuSign.Model.SupportedLanguages.t()} | {:error, Tesla.Env.t()}
Gets the supported languages for envelope recipients.
Retrieves a list of supported languages that you can set for an individual recipient when creating an envelope, as well as their simple type enumeration values. These are the languages that you can set for the standard email format and signing view for each recipient. For example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience. Note: Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the emailBody
and emailSubject
of the notification is not translated, and appears exactly as you enter it. For more information, see Set Recipient Language and Specify Custom Email Messages.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.SupportedLanguages.t}
on success{:error, Tesla.Env.t}
on failure
unsupported_file_types_get_unsupported_file_types(connection, account_id, opts \\ [])
View Source@spec unsupported_file_types_get_unsupported_file_types( Tesla.Env.client(), String.t(), keyword() ) :: {:ok, DocuSign.Model.FileTypeList.t()} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}
Gets a list of unsupported file types. Retrieves a list of file types (mime-types and file-extensions) that are not supported for upload through the DocuSign system.
Parameters
connection
(DocuSign.Connection): Connection to serveraccount_id
(String.t): The external account number (int) or account ID GUID.opts
(keyword): Optional parameters
Returns
{:ok, DocuSign.Model.FileTypeList.t}
on success{:error, Tesla.Env.t}
on failure