DocuSign.Api.Accounts (DocuSign v0.3.3) View Source

API calls for all endpoints tagged Accounts.

Link to this section 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. Response The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API.

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. When creating a single account, the body of the request is a [`newAccountDefinition`][newAccountDefinition] object. If the request succeeds. it returns a 201 (Created) 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. ### Account Settings The `accountSettings` property is a [name/value][nameValue] list that can contain the following settings: | Name | Type | Authorization Required | Description | | :------------------------------------------------- | :------ | :---------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | adoptSigConfig | Boolean | Admin | When true, the Signature Adoption Configuration page is available to account administrators. | | allowAccessCodeFormat | Boolean | Admin | When true, the Access Code Format page is available to account administrators. | | allowAccountManagementGranular | Boolean | Admin | When true, the Delegated Administration functionality is available to account. | | allowBulkSend | Boolean | Admin | When true, the account can set if the bulk send feature can be used. | | allowCDWithdraw | Boolean | Admin | When true, signers can withdraw their consent to use electronic signatures. | | allowConnectSendFinishLater | Boolean | Reserved | Reserved for DocuSign. | | allowDataDownload | Boolean | Admin | When true, the account can download envelope data. | | allowEnvelopeCorrect | Boolean | Admin | When true, the account allows in process envelopes to be corrected. | | allowEnvelopePublishReporting | Boolean | Admin | When true, the account can access the Envelope Publish section in Classic DocuSign Experience Account Administration. | | allowExpressSignerCertificate | Boolean | Admin | When true, senders are allowed to use the DocuSign Express digital signatures. | | allowExternalSignaturePad | Boolean | Admin | When true, an external signature pad can be used for signing. The signature pad type is set by the externalSignaturePadType property. | | allowInPerson | Boolean | SysAdmin | When true, the account allows In Person Signing. | | allowMarkup | Boolean | Admin | When true, the document markup feature is enabled for the account. | | allowMemberTimezone | Boolean | Admin | When true, account users can set their own time zones. | | allowMergeFields | Boolean | Admin | When true, the account can use merge fields in conjunction with DocuSign for Salesforce. | | allowMultipleSignerAttachments | Boolean | Admin | When true, multiple signer attachments are allowed for an envelope. | | allowOfflineSigning | Boolean | Admin | When true, the account can use Offline Signing and envelopes signed using offline signing on mobile devices are synchronized with this account. This option and the inSessionEnabled option must both be enabled (true) for a caller to use offline signing. | | allowOpenTrustSignerCertificate | Boolean | Admin | When true, senders are allowed to use the OpenTrust digital signatures. | | allowPaymentProcessing | Boolean | Admin | When true, the account can access the Payment Processing set up page. | | allowPersonalSignerCertificate | Boolean | Admin | When true, the account can specify that signers must use personal signer certificates during signing. | | allowPrivateSigningGroups | Boolean | SysAdmin Read Only | Reserved for DocuSign. This currently returns false in a response. This setting is only shown in the response when listing account settings. | | allowReminders | Boolean | Admin | When true, the reminder and expiration functionality is available when sending envelops. | | allowSafeBioPharmaSignerCertificate | Boolean | Admin | When true, senders are allowed to use the SAFE BioPharma digital signatures. | | allowSharedTabs | Boolean | Admin | When true, the account allows users to share custom tabs (fields). <br> This setting is only shown when getting account settings. It cannot be modified. | | allowSignDocumentFromHomePage | Boolean | Admin | When true, the Sign a Document Now button is available on the Home tab. | | allowSignatureStamps | Boolean | Reserved | Reserved for DocuSign. | | allowSignerReassign | Boolean | Admin | When true, the account allows signers to reassign an envelope. | | allowSignerReassignOverride | Boolean | Admin | When true, the sender has the option override the default account setting for reassigning recipients. | | allowSigningGroups | Boolean | SysAdmin Read Only | When true, the account can use signing groups. This setting is only shown in the response when listing account settings. | | allowTabOrder | Boolean | Admin | When true, the Tab Order field is available for use when creating tabs. | | allowWorkspaceComments | Boolean | Reserved | Reserved for DocuSign. | | allowWorkspaceCreate | Boolean | Admin | When true, account users can create DocuSign Rooms. | | attachCompletedEnvelope | Boolean | SysAdmin | When true, envelope documents are included as a PDF file attachment for signing completed emails. | | authenticationCheck | String | Admin | Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: <ul> <li>Phone Authentication</li> <li>SMS Authentication</li> <li>Knowledge-Based ID</li> </ul> This setting takes one of the following options: <ul> <li><p><code>initial_access</code>: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account.</p></li> <li><p><code>each_access</code>: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable timeframe.</p></li> </ul> | | autoNavRule | String | Admin | The auto-navigation rule for the account. Enumeration values are: <ul> <li><code>off</li></code> <li><code>required_fields</li></code> <li><code>required_and_blank_fields</li></code> <li><code>all_fields</li></code> <li><code>page_then_required_fields</li></code> <li><code>page_then_required_and_blank_fields</li></code> <li><code>page_then_all_fields</li></code> </ul> | | bulkSend | Boolean | Admin | When true, the account allows bulk sending of envelopes. | | canSelfBrandSend | Boolean | SysAdmin | When true, account administrators can self-brand their sending console through the DocuSign Console. | | canSelfBrandSign | Boolean | SysAdmin | When true, account administrators can self-brand their signing console through the DocuSign Console. | | conditionalFieldsEnabled | Boolean | Admin | When true, conditional fields can be used by the account. | | consumerDisclosureFrequency | enum | Admin | Possible values are: <ul> <li> <code>once</code>: Per account, the supplemental document is displayed once only per userId. </li> <li> <code>always</code>: Per envelope, the supplemental document is displayed once only per userId. </li> <li> <code>each_access</code>: - Per envelope, the supplemental document is displayed once only per recipientId. </li> </ul> | | dataFieldRegexEnabled | Boolean | Admin | When true, the Regex field is available for tabs with that property. | | dataFieldSizeEnabled | Boolean | Admin | When true, the maximum number of characters field is available for tabs with that property. | | dataPopulationScope | String | Admin | Specifies how data is shared for tabs with the same tabLabel. There are two possible values: <ul> <li> <code>document</code>: Tabs in a document with the same label populate with the same data. </li> <li> <code>envelope</code>: Tabs in all documents in the envelope with the same label populate with the same data. </li> </ul> This setting applies to the following tab types: <ul> <li> Check box </li> <li> Company </li> <li> Data Field </li> <li> Dropdown List </li> <li> Full Name </li> <li> Formula </li> <li> Note </li> <li> Title </li> </ul> Changing this setting affects envelopes that have been sent but not completed. | | disableMobilePushNotifications | Boolean | Admin | When true, mobile push notifications are disabled on the account. | | disableMobileSending | Boolean | Admin | When true, sending from mobile applications is disabled. | | disableMultipleSessions | Boolean | Admin | When true, account users cannot be logged into multiple sessions at once. | | disableUploadSignature | Boolean | Admin | When true, signers cannot use the upload signature/initials image option when signing a document. | | documentConversionRestrictions | String | Admin | Sets the account document upload restriction for non-account administrators. There are three possible values: <ul> <li> <code>no_restrictions</code> : there are no restrictions on the type of documents that can be uploaded. </li> <li> <code>allow_pdf_only</code> : only: non-administrators can only upload PDF files. </li> <li> <code>no_upload</code> : Non-administrators cannot upload files. </li> </ul> | | enableAutoNav | Boolean | SysAdmin or EnableAutoNavByDSAdmin is set | When true, the auto-navigation is enabled for the account. | | enableCalculatedFields | Boolean | Admin & AllowExpression is set | When true, this account can use the Calculated Fields feature. | | enableDSPro | Boolean | SysAdmin | When true, this account can send and manage envelopes from the DocuSign Desktop Client. | | enableEnvelopeStampingByAccountAdmin | Boolean | SysAdmin or account has EnableEnvelopeStampingByDSAdmin set | When true, senders for this account can choose to have the envelope ID stamped in the document margins. | | enablePaymentProcessing | Boolean | Admin & AllowPaymentProcessing is set. | When true, Payment Processing is enabled for the account. | | enablePowerForm | Boolean | SysAdmin | When true, PowerForm access is enabled for the account. | | enablePowerFormDirect | Boolean | Admin | When true, direct PowerForms are enabled for the account. | | enableRecipientDomainValidation | Boolean | Admin | When true, validation on recipient email domains for DocuSign Access feature is enabled. | | enableRequireSignOnPaper | Boolean | Admin | When true, the account can use the requireSignOnPaper option. | | enableReservedDomain | Boolean | SysAdmin | When true, an account administrator can reserve web domain and users. | | enableSMSAuthentication | Boolean | Admin | When true, the account can use SMS authentication. | | enableSendToAgent | Boolean | SysAdmin | When true, this account can use the Agent Recipient Type. | | enableSendToIntermediary | Boolean | Admin & AllowSendToIntermediary is set | When true, this account can use the Intermediary Recipient Type. | | enableSendToManage | Boolean | Admin | When true, this account can use the Editor Recipient Type. | | enableSequentialSigningAPI | Boolean | SysAdmin | When true, the account can define the routing order of recipients for envelopes sent using the DocuSign API. | | enableSequentialSigningUI | Boolean | SysAdmin | When true, the account can define the routing order of recipients for envelopes sent using the DocuSign console. | | enableSignOnPaper | Boolean | Admin | When true, a user can allow signers to use the sign on paper option. | | enableSignOnPaperOverride | Boolean | Admin | When true, a user can override the default account setting for the sign on paper option. | | enableSignerAttachments | Boolean | Admin | When true, a user can request attachments from a signer. | | enableTransactionPoint | Boolean | SysAdmin | When true, Transaction Point is enabled for this account. | | enableVaulting | Boolean | SysAdmin | When true, this account can use electronic vaulting for documents. | | enableWorkspaces | Boolean | Admin | When true, DocuSign Rooms is enabled for the account. | | envelopeIntegrationAllowed | String | SysAdmin | Shows the envelope integration rule for the account. <br> Enumeration values are: NotAllowed, Full, IntegrationSendOnly. | | envelopeIntegrationEnabled | Boolean | Admin & EnvelopeIntegrationAllowed is set | When true, envelope integration is enabled for the account. | | envelopeStamplingDefaultValue | Boolean | (GET only) | When true, envelopes sent by this account automatically have the envelope ID stamped in the margins, unless the sender selects not to have them stamped. | | externalSignaturePadType | String | Admin | Sets the type of signature pad that can be used. Possible values are: <ul> <li> <code>none</code> </li> <li> <code>topaz</code> </li> <li> <code>e_padv9</code> </li> <li> <code>e_pad_integrisign</code> </li> </ul> | | faxOutEnabled | Boolean | Admin | When true, the account can use the fax out feature. | | idCheckExpire | String | Admin | Indicates when a user's authentication expires. Possible values are: <ul> <li> <code>always</code> </li> <li> <code>never</code> </li> <li> <code>variable</code>: Use the value in <code>idCheckExpireDays</code> </li> </ul> | | idCheckExpireDays | Integer | Admin | The number of days before a user's authentication expires. Valid only if the `IDCheckExpire` value is Variable. | | idCheckRequired | String | Admin | Indicates if authentication is required by envelope signers. Possible values are: <ul> <li> <code>always</code> </li> <li> <code>never</code> </li> <li> <code>optional</code>: Authentication is determined by the sender. </li> </ul> | | inPersonIDCheckQuestion | String | Admin | The default question used by the In Person signing host for an In Person signing session. | | inSessionEnabled | Boolean | Admin | When true, the account can use In Session (embedded) and offline signing. This option and the allowOfflineSigning option must both be enabled (true) for a caller to use offline signing. | | inSessionSuppressEmails | Boolean | Admin | When true, emails are not sent to the embedded recipients on an envelope for the account. | | maximumSigningGroups | String | SysAdmin Read Only | The maximum number of signing groups an account can have. The default value for this is 50. This setting is only shown in the response when listing account settings. | | maximumUsersPerSigningGroup | String | SysAdmin Read Only | The maximum number of members in a signing group. The default value for this is 50. This setting is only shown in the response when listing account settings. | | mobileSessionTimeout | String | Admin | Sets the amount of idle activity time, in minutes, before a mobile user is automatically logged off of the system. If the setting is 0, then DocuSign mobile application users are never automatically logged off the system. The minimum setting is 1 minute and the maximum setting is 120 minutes. <br> This setting only applies to the DocuSign for iOS v2.8.2 or later mobile app. | | phoneAuthRecipientMayProvidePhoneNumber | Boolean | Admin | When true, senders can select to allow the recipient to provide a phone number for the Phone Authentication process. | | pkiSignDownloadedPDFDocs | String | Admin | The policy for adding a digital certificate to downloaded, printed and emailed documents. Possible values are: <ul> <li> <code>no_sign</code> </li> <li> <code>no_sign_allow_user_override</code> </li> <li> <code>yes_sign</code> </li> </ul> | | recipientsCanSignOffline | Boolean | Admin | When true, envelopes signed using offline signing on mobile devices are synchronized with this account. | | requireDeclineReason | Boolean | Admin | When true, recipients that decline to sign an envelope must provide a reason. | | requireSignerCertificateType | String | Admin | Sets which Digital Signature certificate is required when sending envelopes. There are three possible values: <ul> <li> <code>none</code>: a Digital Signature certificate is not required. </li> <li> <code>docusign_express</code>: signers must use a DocuSign Express certificate. </li> <li> <code>docusign_personal</code>: signers must use a DocuSign personal certificate. </li> <li> <code>open_trust</code>: signers must use an OpenTrust certificate. </li> </ul> | | rsaVeridAccountName | String | Admin | The RSA account name.<br> Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | | rsaVeridPassword | String | Admin | The password used with the RSA account.<br>Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | | rsaVeridRuleset | String | Admin | The RSA rule set used with the account. <br>Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | | rsaVeridUserId | String | Admin | The user ID for the RSA account. <br>Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | | savingCustomTabsEnabled | Boolean | Admin | When true, account users can save custom tabs. | | selfSignedRecipientEmailDocument | String | Admin | Sets how self-signed documents are presented to the email recipients. Possible values are: <ul> <li><code>include_pdf</code>: A PDF of the completed document is attached to the email</li> <li><code>include_link</code>: A secure link to the self-signed documents is included in the email.</li> </ul> | | selfSignedRecipientEmailDocumentRights | Boolean | Admin | When true, account administrators can set the selfSignedRecipientEmailDocument option. | | selfSignedRecipientEmailDocumentUserOverride | Boolean | Admin | When true the selfSignedRecipientEmailDocument userSetting can be set for an individual user. The userSetting will override the account setting. | | selfSignedRecipientEmailDocumentUserOverrideRights | Boolean | Admin | When true, account administrators can set the selfSignedRecipientEmailDocumentOverride option. | | sendToCertifiedDeliveryEnabled | Boolean | Admin | When true, the Certified Deliveries Recipient type can be used by the account. | | senderMustAuthenticateSigning | Boolean | Admin | When true, a sender that is also a recipient of an envelope must follow the authentication requirements for the envelope. | | sessionTimeout | Integer | Admin | The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes. | | setRecipEmailLang | Boolean | Admin | When true, senders can set the email languages for each recipient. | | setRecipSignLang | Boolean | Admin | When true, senders can set the signing language used for each recipient. | | sharedCustomTabsEnabled | Boolean | Admin | When true, saved custom tabs can be shared with account users. | | signDateFormat | String | Admin | The date/time format applied to Date Signed fields for the account. | | signTimeShowAmPm | Boolean | Admin | When true, AM or PM is shown as part of the time for signDateFormat. | | signerAttachCertificateToEnvelopePDF | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, the Certificate of Completion is included in the envelope documents PDF when it is downloaded. | | signerAttachConcat | Boolean | Admin | When true, signer attachments are added to the parent document that the attachment tab is located on, instead of the default behavior that creates a new document in the envelope for every signer attachment. | | signerCanCreateAccount | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, the signer without a DocuSign account can create a DocuSign account after signing. | | signerCanSignOnMobile | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, signers can use the DocuSign mobile signing user interface. | | signerInSessionUseEnvelopeCompleteEmail | Boolean | Admin | When true, an envelope complete email is sent to an In Session (embedded) or offline signer after DocuSign processes the envelope. | | signerLoginRequirements | String | Admin | Sets the Login requirements for the signer. There are four options: <ul> <li> <code>login_not_required</code>: The signer is not required to log on to the system. </li> <li> <code>login_required_if_account_holder</code>: If the signer has a DocuSign account, they must log on to sign the document. </li> <li> <code>login_required_per_session</code>: The sender cannot send an envelope to anyone who does not have a DocuSign account. </li> <li> <code>login_required_per_envelope</code>: The sender cannot send an envelope to anyone who does not have a DocuSign account and the signer must log on the system for each envelope they will sign. </li> </ul> If you use Direct PowerForms or captive/embedded signers, the "Account required" settings are bypassed for those signers. If your workflow requires that the signer have an account, you should not use those methods. | | signerMustHaveAccount | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, senders can only send an envelope to a recipient that has a DocuSign account. | | signerMustLoginToSign | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, an envelope signer must log in to the DocuSign console to sign an envelope. | | signerShowSecureFieldInitialValues | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, the initial value of all SecureFields is written to the document when sent. | | tabDataLabelEnabled | Boolean | Admin | When true, senders can change the default tabLabel for tabs. | | tabLockingEnabled | Boolean | Admin | When true, the locked option is available for tabs with that property. | | tabTextFormattingEnabled | Boolean | Admin | When true, the formatting options (font type, font size, font color, bold, italic, and underline) are available for tabs with those properties. | | universalSignatureOptIn | Boolean | Reserved | Reserved for DocuSign. | | universalSignatureOptOut | Boolean | Reserved | Reserved for DocuSign. | | useAccountLevelEmail | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, the content of notification emails is determined at the account level. | | useConsumerDisclosure | Boolean | Admin | When true, the account can use supplemental documents. | | usesAPI | Boolean | SysAdmin | When true, the account can use the DocuSign API. | [newAccountDefinition]: #/definitions/newAccountDefinition [nameValue]: #/definitions/nameValue

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. Deletes the signature for one or more captive recipient records; it is primarily used for testing. This 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 recipient names associated with an email address. Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.

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.

Reserved: Gets the shared item status for one or more users. Reserved: 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 the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from.

Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users.

List supported languages for the recipient language setting List supported languages for the recipient language setting

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.

Link to this section Functions

Link to this function

accounts_delete_account(connection, account_id, opts \\ [])

View Source

Specs

accounts_delete_account(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {: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 server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

accounts_get_account(connection, account_id, opts \\ [])

View Source

Specs

accounts_get_account(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.Accounts.t()} | {:error, Tesla.Env.t()}

Retrieves the account information for the specified account. Retrieves the account information for the specified account. Response The `canUpgrade` property contains is a Boolean that indicates whether the account can be upgraded through the API.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :include_account_settings (String.t): When set to true, includes the account settings for the account in the response.

Returns

} on success {:error, info} on failure

Link to this function

accounts_get_provisioning(connection, opts \\ [])

View Source

Specs

accounts_get_provisioning(Tesla.Env.client(), keyword()) ::
  {: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 server
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

accounts_post_accounts(connection, opts \\ [])

View Source

Specs

accounts_post_accounts(Tesla.Env.client(), keyword()) ::
  {:ok, DocuSign.Model.NewAccountSummary.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. When creating a single account, the body of the request is a [`newAccountDefinition`][newAccountDefinition] object. If the request succeeds. it returns a 201 (Created) 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. ### Account Settings The `accountSettings` property is a [name/value][nameValue] list that can contain the following settings: | Name | Type | Authorization Required | Description | | :------------------------------------------------- | :------ | :---------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | adoptSigConfig | Boolean | Admin | When true, the Signature Adoption Configuration page is available to account administrators. | | allowAccessCodeFormat | Boolean | Admin | When true, the Access Code Format page is available to account administrators. | | allowAccountManagementGranular | Boolean | Admin | When true, the Delegated Administration functionality is available to account. | | allowBulkSend | Boolean | Admin | When true, the account can set if the bulk send feature can be used. | | allowCDWithdraw | Boolean | Admin | When true, signers can withdraw their consent to use electronic signatures. | | allowConnectSendFinishLater | Boolean | Reserved | Reserved for DocuSign. | | allowDataDownload | Boolean | Admin | When true, the account can download envelope data. | | allowEnvelopeCorrect | Boolean | Admin | When true, the account allows in process envelopes to be corrected. | | allowEnvelopePublishReporting | Boolean | Admin | When true, the account can access the Envelope Publish section in Classic DocuSign Experience Account Administration. | | allowExpressSignerCertificate | Boolean | Admin | When true, senders are allowed to use the DocuSign Express digital signatures. | | allowExternalSignaturePad | Boolean | Admin | When true, an external signature pad can be used for signing. The signature pad type is set by the externalSignaturePadType property. | | allowInPerson | Boolean | SysAdmin | When true, the account allows In Person Signing. | | allowMarkup | Boolean | Admin | When true, the document markup feature is enabled for the account. | | allowMemberTimezone | Boolean | Admin | When true, account users can set their own time zones. | | allowMergeFields | Boolean | Admin | When true, the account can use merge fields in conjunction with DocuSign for Salesforce. | | allowMultipleSignerAttachments | Boolean | Admin | When true, multiple signer attachments are allowed for an envelope. | | allowOfflineSigning | Boolean | Admin | When true, the account can use Offline Signing and envelopes signed using offline signing on mobile devices are synchronized with this account. This option and the inSessionEnabled option must both be enabled (true) for a caller to use offline signing. | | allowOpenTrustSignerCertificate | Boolean | Admin | When true, senders are allowed to use the OpenTrust digital signatures. | | allowPaymentProcessing | Boolean | Admin | When true, the account can access the Payment Processing set up page. | | allowPersonalSignerCertificate | Boolean | Admin | When true, the account can specify that signers must use personal signer certificates during signing. | | allowPrivateSigningGroups | Boolean | SysAdmin Read Only | Reserved for DocuSign. This currently returns false in a response. This setting is only shown in the response when listing account settings. | | allowReminders | Boolean | Admin | When true, the reminder and expiration functionality is available when sending envelops. | | allowSafeBioPharmaSignerCertificate | Boolean | Admin | When true, senders are allowed to use the SAFE BioPharma digital signatures. | | allowSharedTabs | Boolean | Admin | When true, the account allows users to share custom tabs (fields). <br> This setting is only shown when getting account settings. It cannot be modified. | | allowSignDocumentFromHomePage | Boolean | Admin | When true, the Sign a Document Now button is available on the Home tab. | | allowSignatureStamps | Boolean | Reserved | Reserved for DocuSign. | | allowSignerReassign | Boolean | Admin | When true, the account allows signers to reassign an envelope. | | allowSignerReassignOverride | Boolean | Admin | When true, the sender has the option override the default account setting for reassigning recipients. | | allowSigningGroups | Boolean | SysAdmin Read Only | When true, the account can use signing groups. This setting is only shown in the response when listing account settings. | | allowTabOrder | Boolean | Admin | When true, the Tab Order field is available for use when creating tabs. | | allowWorkspaceComments | Boolean | Reserved | Reserved for DocuSign. | | allowWorkspaceCreate | Boolean | Admin | When true, account users can create DocuSign Rooms. | | attachCompletedEnvelope | Boolean | SysAdmin | When true, envelope documents are included as a PDF file attachment for signing completed emails. | | authenticationCheck | String | Admin | Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: <ul> <li>Phone Authentication</li> <li>SMS Authentication</li> <li>Knowledge-Based ID</li> </ul> This setting takes one of the following options: <ul> <li><p><code>initial_access</code>: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account.</p></li> <li><p><code>each_access</code>: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable timeframe.</p></li> </ul> | | autoNavRule | String | Admin | The auto-navigation rule for the account. Enumeration values are: <ul> <li><code>off</li></code> <li><code>required_fields</li></code> <li><code>required_and_blank_fields</li></code> <li><code>all_fields</li></code> <li><code>page_then_required_fields</li></code> <li><code>page_then_required_and_blank_fields</li></code> <li><code>page_then_all_fields</li></code> </ul> | | bulkSend | Boolean | Admin | When true, the account allows bulk sending of envelopes. | | canSelfBrandSend | Boolean | SysAdmin | When true, account administrators can self-brand their sending console through the DocuSign Console. | | canSelfBrandSign | Boolean | SysAdmin | When true, account administrators can self-brand their signing console through the DocuSign Console. | | conditionalFieldsEnabled | Boolean | Admin | When true, conditional fields can be used by the account. | | consumerDisclosureFrequency | enum | Admin | Possible values are: <ul> <li> <code>once</code>: Per account, the supplemental document is displayed once only per userId. </li> <li> <code>always</code>: Per envelope, the supplemental document is displayed once only per userId. </li> <li> <code>each_access</code>: - Per envelope, the supplemental document is displayed once only per recipientId. </li> </ul> | | dataFieldRegexEnabled | Boolean | Admin | When true, the Regex field is available for tabs with that property. | | dataFieldSizeEnabled | Boolean | Admin | When true, the maximum number of characters field is available for tabs with that property. | | dataPopulationScope | String | Admin | Specifies how data is shared for tabs with the same tabLabel. There are two possible values: <ul> <li> <code>document</code>: Tabs in a document with the same label populate with the same data. </li> <li> <code>envelope</code>: Tabs in all documents in the envelope with the same label populate with the same data. </li> </ul> This setting applies to the following tab types: <ul> <li> Check box </li> <li> Company </li> <li> Data Field </li> <li> Dropdown List </li> <li> Full Name </li> <li> Formula </li> <li> Note </li> <li> Title </li> </ul> Changing this setting affects envelopes that have been sent but not completed. | | disableMobilePushNotifications | Boolean | Admin | When true, mobile push notifications are disabled on the account. | | disableMobileSending | Boolean | Admin | When true, sending from mobile applications is disabled. | | disableMultipleSessions | Boolean | Admin | When true, account users cannot be logged into multiple sessions at once. | | disableUploadSignature | Boolean | Admin | When true, signers cannot use the upload signature/initials image option when signing a document. | | documentConversionRestrictions | String | Admin | Sets the account document upload restriction for non-account administrators. There are three possible values: <ul> <li> <code>no_restrictions</code> : there are no restrictions on the type of documents that can be uploaded. </li> <li> <code>allow_pdf_only</code> : only: non-administrators can only upload PDF files. </li> <li> <code>no_upload</code> : Non-administrators cannot upload files. </li> </ul> | | enableAutoNav | Boolean | SysAdmin or EnableAutoNavByDSAdmin is set | When true, the auto-navigation is enabled for the account. | | enableCalculatedFields | Boolean | Admin & AllowExpression is set | When true, this account can use the Calculated Fields feature. | | enableDSPro | Boolean | SysAdmin | When true, this account can send and manage envelopes from the DocuSign Desktop Client. | | enableEnvelopeStampingByAccountAdmin | Boolean | SysAdmin or account has EnableEnvelopeStampingByDSAdmin set | When true, senders for this account can choose to have the envelope ID stamped in the document margins. | | enablePaymentProcessing | Boolean | Admin & AllowPaymentProcessing is set. | When true, Payment Processing is enabled for the account. | | enablePowerForm | Boolean | SysAdmin | When true, PowerForm access is enabled for the account. | | enablePowerFormDirect | Boolean | Admin | When true, direct PowerForms are enabled for the account. | | enableRecipientDomainValidation | Boolean | Admin | When true, validation on recipient email domains for DocuSign Access feature is enabled. | | enableRequireSignOnPaper | Boolean | Admin | When true, the account can use the requireSignOnPaper option. | | enableReservedDomain | Boolean | SysAdmin | When true, an account administrator can reserve web domain and users. | | enableSMSAuthentication | Boolean | Admin | When true, the account can use SMS authentication. | | enableSendToAgent | Boolean | SysAdmin | When true, this account can use the Agent Recipient Type. | | enableSendToIntermediary | Boolean | Admin & AllowSendToIntermediary is set | When true, this account can use the Intermediary Recipient Type. | | enableSendToManage | Boolean | Admin | When true, this account can use the Editor Recipient Type. | | enableSequentialSigningAPI | Boolean | SysAdmin | When true, the account can define the routing order of recipients for envelopes sent using the DocuSign API. | | enableSequentialSigningUI | Boolean | SysAdmin | When true, the account can define the routing order of recipients for envelopes sent using the DocuSign console. | | enableSignOnPaper | Boolean | Admin | When true, a user can allow signers to use the sign on paper option. | | enableSignOnPaperOverride | Boolean | Admin | When true, a user can override the default account setting for the sign on paper option. | | enableSignerAttachments | Boolean | Admin | When true, a user can request attachments from a signer. | | enableTransactionPoint | Boolean | SysAdmin | When true, Transaction Point is enabled for this account. | | enableVaulting | Boolean | SysAdmin | When true, this account can use electronic vaulting for documents. | | enableWorkspaces | Boolean | Admin | When true, DocuSign Rooms is enabled for the account. | | envelopeIntegrationAllowed | String | SysAdmin | Shows the envelope integration rule for the account. <br> Enumeration values are: NotAllowed, Full, IntegrationSendOnly. | | envelopeIntegrationEnabled | Boolean | Admin & EnvelopeIntegrationAllowed is set | When true, envelope integration is enabled for the account. | | envelopeStamplingDefaultValue | Boolean | (GET only) | When true, envelopes sent by this account automatically have the envelope ID stamped in the margins, unless the sender selects not to have them stamped. | | externalSignaturePadType | String | Admin | Sets the type of signature pad that can be used. Possible values are: <ul> <li> <code>none</code> </li> <li> <code>topaz</code> </li> <li> <code>e_padv9</code> </li> <li> <code>e_pad_integrisign</code> </li> </ul> | | faxOutEnabled | Boolean | Admin | When true, the account can use the fax out feature. | | idCheckExpire | String | Admin | Indicates when a user's authentication expires. Possible values are: <ul> <li> <code>always</code> </li> <li> <code>never</code> </li> <li> <code>variable</code>: Use the value in <code>idCheckExpireDays</code> </li> </ul> | | idCheckExpireDays | Integer | Admin | The number of days before a user's authentication expires. Valid only if the `IDCheckExpire` value is Variable. | | idCheckRequired | String | Admin | Indicates if authentication is required by envelope signers. Possible values are: <ul> <li> <code>always</code> </li> <li> <code>never</code> </li> <li> <code>optional</code>: Authentication is determined by the sender. </li> </ul> | | inPersonIDCheckQuestion | String | Admin | The default question used by the In Person signing host for an In Person signing session. | | inSessionEnabled | Boolean | Admin | When true, the account can use In Session (embedded) and offline signing. This option and the allowOfflineSigning option must both be enabled (true) for a caller to use offline signing. | | inSessionSuppressEmails | Boolean | Admin | When true, emails are not sent to the embedded recipients on an envelope for the account. | | maximumSigningGroups | String | SysAdmin Read Only | The maximum number of signing groups an account can have. The default value for this is 50. This setting is only shown in the response when listing account settings. | | maximumUsersPerSigningGroup | String | SysAdmin Read Only | The maximum number of members in a signing group. The default value for this is 50. This setting is only shown in the response when listing account settings. | | mobileSessionTimeout | String | Admin | Sets the amount of idle activity time, in minutes, before a mobile user is automatically logged off of the system. If the setting is 0, then DocuSign mobile application users are never automatically logged off the system. The minimum setting is 1 minute and the maximum setting is 120 minutes. <br> This setting only applies to the DocuSign for iOS v2.8.2 or later mobile app. | | phoneAuthRecipientMayProvidePhoneNumber | Boolean | Admin | When true, senders can select to allow the recipient to provide a phone number for the Phone Authentication process. | | pkiSignDownloadedPDFDocs | String | Admin | The policy for adding a digital certificate to downloaded, printed and emailed documents. Possible values are: <ul> <li> <code>no_sign</code> </li> <li> <code>no_sign_allow_user_override</code> </li> <li> <code>yes_sign</code> </li> </ul> | | recipientsCanSignOffline | Boolean | Admin | When true, envelopes signed using offline signing on mobile devices are synchronized with this account. | | requireDeclineReason | Boolean | Admin | When true, recipients that decline to sign an envelope must provide a reason. | | requireSignerCertificateType | String | Admin | Sets which Digital Signature certificate is required when sending envelopes. There are three possible values: <ul> <li> <code>none</code>: a Digital Signature certificate is not required. </li> <li> <code>docusign_express</code>: signers must use a DocuSign Express certificate. </li> <li> <code>docusign_personal</code>: signers must use a DocuSign personal certificate. </li> <li> <code>open_trust</code>: signers must use an OpenTrust certificate. </li> </ul> | | rsaVeridAccountName | String | Admin | The RSA account name.<br> Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | | rsaVeridPassword | String | Admin | The password used with the RSA account.<br>Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | | rsaVeridRuleset | String | Admin | The RSA rule set used with the account. <br>Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | | rsaVeridUserId | String | Admin | The user ID for the RSA account. <br>Modifying this value might inadvertently disrupt your ID Check capability. Ensure you have the correct value before changing this. | | savingCustomTabsEnabled | Boolean | Admin | When true, account users can save custom tabs. | | selfSignedRecipientEmailDocument | String | Admin | Sets how self-signed documents are presented to the email recipients. Possible values are: <ul> <li><code>include_pdf</code>: A PDF of the completed document is attached to the email</li> <li><code>include_link</code>: A secure link to the self-signed documents is included in the email.</li> </ul> | | selfSignedRecipientEmailDocumentRights | Boolean | Admin | When true, account administrators can set the selfSignedRecipientEmailDocument option. | | selfSignedRecipientEmailDocumentUserOverride | Boolean | Admin | When true the selfSignedRecipientEmailDocument userSetting can be set for an individual user. The userSetting will override the account setting. | | selfSignedRecipientEmailDocumentUserOverrideRights | Boolean | Admin | When true, account administrators can set the selfSignedRecipientEmailDocumentOverride option. | | sendToCertifiedDeliveryEnabled | Boolean | Admin | When true, the Certified Deliveries Recipient type can be used by the account. | | senderMustAuthenticateSigning | Boolean | Admin | When true, a sender that is also a recipient of an envelope must follow the authentication requirements for the envelope. | | sessionTimeout | Integer | Admin | The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes. | | setRecipEmailLang | Boolean | Admin | When true, senders can set the email languages for each recipient. | | setRecipSignLang | Boolean | Admin | When true, senders can set the signing language used for each recipient. | | sharedCustomTabsEnabled | Boolean | Admin | When true, saved custom tabs can be shared with account users. | | signDateFormat | String | Admin | The date/time format applied to Date Signed fields for the account. | | signTimeShowAmPm | Boolean | Admin | When true, AM or PM is shown as part of the time for signDateFormat. | | signerAttachCertificateToEnvelopePDF | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, the Certificate of Completion is included in the envelope documents PDF when it is downloaded. | | signerAttachConcat | Boolean | Admin | When true, signer attachments are added to the parent document that the attachment tab is located on, instead of the default behavior that creates a new document in the envelope for every signer attachment. | | signerCanCreateAccount | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, the signer without a DocuSign account can create a DocuSign account after signing. | | signerCanSignOnMobile | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, signers can use the DocuSign mobile signing user interface. | | signerInSessionUseEnvelopeCompleteEmail | Boolean | Admin | When true, an envelope complete email is sent to an In Session (embedded) or offline signer after DocuSign processes the envelope. | | signerLoginRequirements | String | Admin | Sets the Login requirements for the signer. There are four options: <ul> <li> <code>login_not_required</code>: The signer is not required to log on to the system. </li> <li> <code>login_required_if_account_holder</code>: If the signer has a DocuSign account, they must log on to sign the document. </li> <li> <code>login_required_per_session</code>: The sender cannot send an envelope to anyone who does not have a DocuSign account. </li> <li> <code>login_required_per_envelope</code>: The sender cannot send an envelope to anyone who does not have a DocuSign account and the signer must log on the system for each envelope they will sign. </li> </ul> If you use Direct PowerForms or captive/embedded signers, the "Account required" settings are bypassed for those signers. If your workflow requires that the signer have an account, you should not use those methods. | | signerMustHaveAccount | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, senders can only send an envelope to a recipient that has a DocuSign account. | | signerMustLoginToSign | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, an envelope signer must log in to the DocuSign console to sign an envelope. | | signerShowSecureFieldInitialValues | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, the initial value of all SecureFields is written to the document when sent. | | tabDataLabelEnabled | Boolean | Admin | When true, senders can change the default tabLabel for tabs. | | tabLockingEnabled | Boolean | Admin | When true, the locked option is available for tabs with that property. | | tabTextFormattingEnabled | Boolean | Admin | When true, the formatting options (font type, font size, font color, bold, italic, and underline) are available for tabs with those properties. | | universalSignatureOptIn | Boolean | Reserved | Reserved for DocuSign. | | universalSignatureOptOut | Boolean | Reserved | Reserved for DocuSign. | | useAccountLevelEmail | Boolean | AccountAdmin & account is selected in AccountSigningSettings| When true, the content of notification emails is determined at the account level. | | useConsumerDisclosure | Boolean | Admin | When true, the account can use supplemental documents. | | usesAPI | Boolean | SysAdmin | When true, the account can use the DocuSign API. | [newAccountDefinition]: #/definitions/newAccountDefinition [nameValue]: #/definitions/nameValue

Parameters

  • connection (DocuSign.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters
    • :preview_billing_plan (String.t): When set to true, creates the account using a preview billing plan.
    • :new_account_definition (NewAccountDefinition):

Returns

} on success {:error, info} on failure

Link to this function

billing_charges_get_account_billing_charges(connection, account_id, opts \\ [])

View Source

Specs

billing_charges_get_account_billing_charges(
  Tesla.Env.client(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.BillingChargeResponse.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 server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :include_charges (String.t): Specifies which billing charges to return. Valid values are: envelopes seats

Returns

} on success {:error, info} on failure

Link to this function

captive_recipients_delete_captive_recipients_part(connection, account_id, recipient_part, opts \\ [])

View Source

Specs

captive_recipients_delete_captive_recipients_part(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.CaptiveRecipientInformation.t()}
  | {:error, Tesla.Env.t()}

Deletes the signature for one or more captive recipient records. Deletes the signature for one or more captive recipient records; it is primarily used for testing. This 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 server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • recipient_part (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :captive_recipient_information (CaptiveRecipientInformation):

Returns

} on success {:error, info} on failure

Link to this function

recipient_names_get_recipient_names(connection, account_id, opts \\ [])

View Source

Specs

recipient_names_get_recipient_names(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.RecipientNamesResponse.t()} | {:error, Tesla.Env.t()}

Gets recipient names associated with an email address. Retrieves a list of recipients in the specified account that are associated with a email address supplied in the query string.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :email (String.t): The email address for the user

Returns

} on success {:error, info} on failure

Link to this function

settings_get_settings(connection, account_id, opts \\ [])

View Source

Specs

settings_get_settings(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.AccountSettingsInformation.t()} | {:error, Tesla.Env.t()}

Gets account settings information. Retrieves the account settings information for the specified account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

settings_put_settings(connection, account_id, opts \\ [])

View Source

Specs

settings_put_settings(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Updates the account settings for an account. Updates the account settings for the specified account.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :account_settings_information (AccountSettingsInformation):

Returns

} on success {:error, info} on failure

Link to this function

shared_access_get_shared_access(connection, account_id, opts \\ [])

View Source

Specs

shared_access_get_shared_access(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.AccountSharedAccess.t()} | {:error, Tesla.Env.t()}

Reserved: Gets the shared item status for one or more users. Reserved: 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 the retrieving the status of all members of the account that are sharing their folders to the user. This is equivalent to setting the shared=shared_from.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :count (String.t): Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.
    • :envelopes_not_shared_user_status (String.t):
    • :folder_ids (String.t): A comma separated list of folder ID GUIDs.
    • :item_type (String.t): Reserved:
    • :search_text (String.t): This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string.
    • :shared (String.t): Reserved:
    • :start_position (String.t): Reserved:
    • :user_ids (String.t): Reserved:

Returns

} on success {:error, info} on failure

Link to this function

shared_access_put_shared_access(connection, account_id, opts \\ [])

View Source

Specs

shared_access_put_shared_access(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.AccountSharedAccess.t()} | {:error, Tesla.Env.t()}

Reserved: Sets the shared access information for users. Reserved: Sets the shared access information for one or more users.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters
    • :item_type (String.t):
    • :user_ids (String.t):
    • :account_shared_access (AccountSharedAccess):

Returns

} on success {:error, info} on failure

Link to this function

supported_languages_get_supported_languages(connection, account_id, opts \\ [])

View Source

Specs

supported_languages_get_supported_languages(
  Tesla.Env.client(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.SupportedLanguages.t()} | {:error, Tesla.Env.t()}

List supported languages for the recipient language setting List supported languages for the recipient language setting

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

unsupported_file_types_get_unsupported_file_types(connection, account_id, opts \\ [])

View Source

Specs

unsupported_file_types_get_unsupported_file_types(
  Tesla.Env.client(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.FileTypeList.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 server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure