module:api/AccountsApi

module:api/AccountsApi

new module:api/AccountsApi(apiClient)

Source:

Constructs a new AccountsApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use,
default to module:ApiClient#instance if unspecified.

Methods

_delete(accountId, optsOrCallback, callback)

Source:

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:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
redactUserData String
callback module:api/AccountsApi~_deleteCallback

The callback function, accepting three arguments: error, data, response

create(optsOrCallback, callback)

Source:

Creates new accounts.
Creates new DocuSign service accounts.

This is used to create multiple DocuSign accounts with one call. It uses the same information and formats as the normal a Accounts:create call with the information included within a newAccountRequests element. A maximum of 100 new accounts can be created at one time.

Note that the structure of the XML request is slightly different than the JSON request, in that the new account information is included in a newAccountDefinition property inside the newAccountRequests element.
Response

The response returns the new account ID, password and the default user information for each newly created account.

A 201 code is returned if the call succeeded. While the call may have succeed, some of the individual account requests may have failed. In the case of failures to create the account, an errorDetails node is added in the response to each specific request that failed.

Parameters:
Name Type Description
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
previewBillingPlan String

When set to true, creates the account using a preview billing plan.
newAccountDefinition module:model/NewAccountDefinition
callback module:api/AccountsApi~createCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/NewAccountSummary

createAccountSignatures(accountId, optsOrCallback, callback)

Source:

Adds/updates one or more account signatures. This request may include images in multi-part format.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
decodeOnly String
accountSignaturesInformation module:model/AccountSignaturesInformation
callback module:api/AccountsApi~createAccountSignaturesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSignaturesInformation

createBrand(accountId, optsOrCallback, callback)

Source:

Creates one or more brand profile files for the account.
Creates one or more brand profile files for the account. The Account Branding feature (accountSettings properties canSelfBrandSend and canSelfBrandSig) must be set to true for the account to use this call.

An error is returned if brandId property for a brand profile is already set for the account. To upload a new version of an existing brand profile, you must delete the profile and then upload the newer version.

When brand profile files are being uploaded, they must be combined into one zip file and the Content-Type must be application/zip.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID GUID.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
brand module:model/Brand
callback module:api/AccountsApi~createBrandCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/BrandsResponse

createCustomField(accountId, optsOrCallback, callback)

Source:

Creates an acount custom field.
This method creates a custom field and makes it available for all new envelopes associated with an account.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
applyToTemplates String
customField module:model/CustomField
callback module:api/AccountsApi~createCustomFieldCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CustomFields

createPermissionProfile(accountId, optsOrCallback, callback)

Source:

Creates a new permission profile in the specified account.
This method creates a new permission profile for an account.

Related topics

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
include String
permissionProfile module:model/PermissionProfile
callback module:api/AccountsApi~createPermissionProfileCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PermissionProfile

createUserAuthorization(accountId, userId, optsOrCallback, callback)

Source:

Creates the user authorization

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
userAuthorizationCreateRequest module:model/UserAuthorizationCreateRequest
callback module:api/AccountsApi~createUserAuthorizationCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserAuthorization

createUserAuthorizations(accountId, userId, optsOrCallback, callback)

Source:

Creates ot updates user authorizations

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
userAuthorizationsRequest module:model/UserAuthorizationsRequest
callback module:api/AccountsApi~createUserAuthorizationsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserAuthorizationsResponse

deleteAccountSignature(accountId, signatureId, callback)

Source:

Close the specified signature by Id.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signatureId String

The ID of the signature being accessed.
callback module:api/AccountsApi~deleteAccountSignatureCallback

The callback function, accepting three arguments: error, data, response

deleteAccountSignatureImage(accountId, signatureId, imageType, callback)

Source:

Deletes a signature, initials, or stamps image.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signatureId String

The ID of the signature being accessed.
imageType String

One of signature_image or initials_image.
callback module:api/AccountsApi~deleteAccountSignatureImageCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSignature

deleteBrand(accountId, brandId, callback)

Source:

Removes a brand.
This method deletes a brand from an account.
Note:* Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
brandId String

The unique identifier of a brand.
callback module:api/AccountsApi~deleteBrandCallback

The callback function, accepting three arguments: error, data, response

deleteBrandLogoByType(accountId, brandId, logoType, callback)

Source:

Delete one branding logo.
This method deletes a single logo from an account brand.
Note:* Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
brandId String

The unique identifier of a brand.
logoType String

One of Primary, Secondary or Email.
callback module:api/AccountsApi~deleteBrandLogoByTypeCallback

The callback function, accepting three arguments: error, data, response

deleteBrands(accountId, optsOrCallback, callback)

Source:

Deletes one or more brand profiles.
Deletes one or more brand profiles from an account. The Account Branding feature (accountSettings properties canSelfBrandSend and canSelfBrandSend) must be set to true to use this call.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
brandsRequest module:model/BrandsRequest
callback module:api/AccountsApi~deleteBrandsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/BrandsResponse

deleteCaptiveRecipient(accountId, recipientPart, optsOrCallback, callback)

Source:

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:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
recipientPart String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
captiveRecipientInformation module:model/CaptiveRecipientInformation
callback module:api/AccountsApi~deleteCaptiveRecipientCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CaptiveRecipientInformation

deleteCustomField(accountId, customFieldId, optsOrCallback, callback)

Source:

Delete an existing account custom field.
This method deletes an existing account custom field.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
customFieldId String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
applyToTemplates String
callback module:api/AccountsApi~deleteCustomFieldCallback

The callback function, accepting three arguments: error, data, response

deleteENoteConfiguration(accountId, callback)

Source:

Deletes configuration information for the eNote eOriginal integration.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~deleteENoteConfigurationCallback

The callback function, accepting three arguments: error, data, response

deletePermissionProfile(accountId, permissionProfileId, optsOrCallback, callback)

Source:

Deletes a permissions profile within the specified account.
This method deletes a permission profile from an account.

To delete a permission profile, it must not have any users associated with it. When you use this method to delete a permission profile, you can reassign the users associated with it to a new permission profile at the same time by using the move_users_to query parameter.

Related topics

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
permissionProfileId String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
moveUsersTo String
callback module:api/AccountsApi~deletePermissionProfileCallback

The callback function, accepting three arguments: error, data, response

deleteUserAuthorization(accountId, userId, authorizationId, callback)

Source:

Deletes the user authorization

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId String
callback module:api/AccountsApi~deleteUserAuthorizationCallback

The callback function, accepting three arguments: error, data, response

deleteUserAuthorizations(accountId, userId, optsOrCallback, callback)

Source:

Creates ot updates user authorizations

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
userAuthorizationsDeleteRequest module:model/UserAuthorizationsDeleteRequest
callback module:api/AccountsApi~deleteUserAuthorizationsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserAuthorizationsDeleteResponse

getAccountIdentityVerification(accountId, optsOrCallback, callback)

Source:

Get the list of identity verification options for an account
This method returns a list of Identity Verification workflows that are available to an account.
Note:* To use this method, you must either be an account administrator or a sender.

Related topics

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
identityVerificationWorkflowStatus String
callback module:api/AccountsApi~getAccountIdentityVerificationCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountIdentityVerificationResponse

getAccountInformation(accountId, optsOrCallback, callback)

Source:

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:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
includeAccountSettings String

When set to true, includes the account settings for the account in the response.
callback module:api/AccountsApi~getAccountInformationCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountInformation

getAccountSignature(accountId, signatureId, callback)

Source:

Returns information about a single signature by specifed signatureId.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signatureId String

The ID of the signature being accessed.
callback module:api/AccountsApi~getAccountSignatureCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSignature

getAccountSignatureImage(accountId, signatureId, imageType, optsOrCallback, callback)

Source:

Returns a signature, initials, or stamps image.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signatureId String

The ID of the signature being accessed.
imageType String

One of signature_image or initials_image.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
includeChrome String
callback module:api/AccountsApi~getAccountSignatureImageCallback

The callback function, accepting three arguments: error, data, response
data is of type: Object

getAccountSignatures(accountId, optsOrCallback, callback)

Source:

Returns the managed signature definitions for the account

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
stampFormat String
stampName String
stampType String
callback module:api/AccountsApi~getAccountSignaturesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSignaturesInformation

getAccountTabSettings(accountId, callback)

Source:

Returns tab settings list for specified account
This method returns information about the tab types and tab functionality that is currently enabled for an account.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~getAccountTabSettingsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TabAccountSettings

getAgentUserAuthorizations(accountId, userId, optsOrCallback, callback)

Source:

Returns the agent user authorizations

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
activeOnly String
count String
emailSubstring String

Part (substring) of email we are searching for.
includeClosedUsers String
permissions String
startPosition String
userNameSubstring String
callback module:api/AccountsApi~getAgentUserAuthorizationsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserAuthorizations

getAllPaymentGatewayAccounts(accountId, callback)

Source:

Get all payment gateway account for the provided accountId
This method returns a list of payment gateway accounts and basic information about them.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~getAllPaymentGatewayAccountsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PaymentGatewayAccountsInfo

getBillingCharges(accountId, optsOrCallback, callback)

Source:

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:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
includeCharges String

Specifies which billing charges to return. Valid values are: * envelopes * seats
callback module:api/AccountsApi~getBillingChargesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/BillingChargeResponse

getBrand(accountId, brandId, optsOrCallback, callback)

Source:

Get information for a specific brand.
This method returns details about an account brand.
Note:* Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
brandId String

The unique identifier of a brand.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
includeExternalReferences String
includeLogos String
callback module:api/AccountsApi~getBrandCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Brand

getBrandExportFile(accountId, brandId, callback)

Source:

Export a specific brand.
This method exports information about a brand to an XML file.
Note:* Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
brandId String

The unique identifier of a brand.
callback module:api/AccountsApi~getBrandExportFileCallback

The callback function, accepting three arguments: error, data, response

getBrandLogoByType(accountId, brandId, logoType, callback)

Source:

Obtains the specified image for a brand.
This method returns a specific logo that is used in a brand.
Note:* Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
brandId String

The unique identifier of a brand.
logoType String

One of Primary, Secondary or Email.
callback module:api/AccountsApi~getBrandLogoByTypeCallback

The callback function, accepting three arguments: error, data, response
data is of type: Object

getBrandResources(accountId, brandId, callback)

Source:

Returns the specified account's list of branding resources (metadata).
This method returns metadata about the branding resources that are associated with an account.
Note:* Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
brandId String

The unique identifier of a brand.
callback module:api/AccountsApi~getBrandResourcesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/BrandResourcesList

getBrandResourcesByContentType(accountId, brandId, resourceContentType, optsOrCallback, callback)

Source:

Returns the specified branding resource file.
This method returns a specific branding resource file.

A brand uses a set of brand resource files to control the sending, signing, email message, and captive (embedded) signing experiences. You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.
Important:* When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.
Note:* Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
brandId String

The unique identifier of a brand.
resourceContentType String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
langcode String
returnMaster String
callback module:api/AccountsApi~getBrandResourcesByContentTypeCallback

The callback function, accepting three arguments: error, data, response

getConsumerDisclosure(accountId, langCode, callback)

Source:

Gets the Electronic Record and Signature Disclosure.
Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, for the requested envelope recipient. This might be different than the current account disclosure depending on account settings, such as branding, and when the account disclosure was last updated. An optional query string can be included to return the language for the disclosure.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
langCode String

The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), 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 Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (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) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
callback module:api/AccountsApi~getConsumerDisclosureCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ConsumerDisclosure

getConsumerDisclosureDefault(accountId, optsOrCallback, callback)

Source:

Gets the Electronic Record and Signature Disclosure for the account.
Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
langCode String

Specifies the language used in the response. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Armenian (hy), 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 Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (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), and Vietnamese (vi). Additionally, the value can be set to browser to automatically detect the browser language being used by the viewer and display the disclosure in that language.
callback module:api/AccountsApi~getConsumerDisclosureDefaultCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ConsumerDisclosure

getENoteConfiguration(accountId, callback)

Source:

Returns the configuration information for the eNote eOriginal integration.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~getENoteConfigurationCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ENoteConfiguration

getEnvelopePurgeConfiguration(accountId, callback)

Source:

Select envelope purge configuration.
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:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~getEnvelopePurgeConfigurationCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/EnvelopePurgeConfiguration

getFavoriteTemplates(accountId, callback)

Source:

Retrieves the list of favorited templates for this caller

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~getFavoriteTemplatesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/FavoriteTemplatesInfo

getNotificationDefaults(accountId, callback)

Source:

Returns default user level settings for a specified account
This method returns the default settings for the email notifications that signers and senders receive about envelopes.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~getNotificationDefaultsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/NotificationDefaults

getPasswordRules(accountId, callback)

Source:

Get the password rules
This method retrieves the password rules for an account.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~getPasswordRulesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountPasswordRules

getPasswordRules_0(callback)

Source:

Get membership account password rules

Parameters:
Name Type Description
callback module:api/AccountsApi~getPasswordRules_0Callback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserPasswordRules

getPermissionProfile(accountId, permissionProfileId, optsOrCallback, callback)

Source:

Returns a permissions profile in the specified account.
This method returns information about a specific permission profile that is associated with an account.

Related topics

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
permissionProfileId String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
include String
callback module:api/AccountsApi~getPermissionProfileCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PermissionProfile

getPrincipalUserAuthorizations(accountId, userId, optsOrCallback, callback)

Source:

Returns the principal user authorizations

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
activeOnly String
count String
emailSubstring String

Part (substring) of email we are searching for.
includeClosedUsers String
permissions String
startPosition String
userNameSubstring String
callback module:api/AccountsApi~getPrincipalUserAuthorizationsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserAuthorizations

getProvisioning(callback)

Source:

Retrieves the account provisioning information for the account.
Retrieves the account provisioning information for the account.

Parameters:
Name Type Description
callback module:api/AccountsApi~getProvisioningCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ProvisioningInformation

getSupportedLanguages(accountId, callback)

Source:

Gets list of supported languages for recipient language setting.
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:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~getSupportedLanguagesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/SupportedLanguages

getUserAuthorization(accountId, userId, authorizationId, callback)

Source:

Returns the user authorization for a given authorization id

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId String
callback module:api/AccountsApi~getUserAuthorizationCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserAuthorization

getWatermark(accountId, callback)

Source:

Get watermark information.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~getWatermarkCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Watermark

getWatermarkPreview(accountId, optsOrCallback, callback)

Source:

Get watermark preview.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
watermark module:model/Watermark
callback module:api/AccountsApi~getWatermarkPreviewCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Watermark

listBrands(accountId, optsOrCallback, callback)

Source:

Gets a list of brand profiles.
Retrieves the list of brand profiles associated with the account and the default brand profiles. The Account Branding feature (accountSettings properties canSelfBrandSend and canSelfBrandSend) must be set to true for the account to use this call.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
excludeDistributorBrand String

When set to true, excludes distributor brand information from the response set.
includeLogos String

When set to true, returns the logos associated with the brand.
callback module:api/AccountsApi~listBrandsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/BrandsResponse

listCustomFields(accountId, callback)

Source:

Gets a list of custom fields associated with the account.
Retrieves a list of envelope custom fields associated with the account. You can use these fields in the envelopes for your account to record information about the envelope, help search for envelopes and track information. The envelope custom fields are shown in the Envelope Settings section when a user is creating an envelope in the DocuSign member console. The envelope custom fields are not seen by the envelope recipients.

There are two types of envelope custom fields, text, and list. A text custom field lets the sender enter the value for the field. The list custom field lets the sender select the value of the field from a list you provide.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~listCustomFieldsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CustomFields

listPermissions(accountId, optsOrCallback, callback)

Source:

Gets a list of permission profiles.
Retrieves a list of Permission Profiles. Permission Profiles are a standard set of user permissions that you can apply to individual users or users in a Group. This makes it easier to manage user permissions for a large number of users, without having to change permissions on a user-by-user basis.

Currently, Permission Profiles can only be created and modified in the DocuSign console.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
include String
callback module:api/AccountsApi~listPermissionsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PermissionProfileInformation

listRecipientNamesByEmail(accountId, optsOrCallback, callback)

Source:

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:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
email String

The email address for the user
callback module:api/AccountsApi~listRecipientNamesByEmailCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/RecipientNamesResponse

listSettings(accountId, callback)

Source:

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

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~listSettingsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSettingsInformation

listSharedAccess(accountId, optsOrCallback, callback)

Source:

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:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
count String

Specifies maximum number of results included in the response. If no value is specified, this defaults to 1000.
envelopesNotSharedUserStatus String
folderIds String
itemType String

Specifies the type of shared item being requested. The accepted values are: -envelopes: returns information about envelope sharing between users.
searchText String

This can be used to filter user names in the response. The wild-card '*' (asterisk) can be used around the string.
shared String

Specifies which users should be included in the response. Multiple values can be used in the query by using a comma separated list of shared values. If the requestor does not have account administrator privileges, the shared_to value is used. Requestors that do not have account administrator privileges can only use the shared_to, any other setting will result in an error. The accepted values are: -not_shared: Returns account users that the specified item type is not being shared with and that are not sharing the specified item type with the user. User X (Share) X Account user -shared_to: Returns account users that the specified item type is not being shared with and who are sharing the specified item type with the user (only shared to the user). User X (Share) Account user -shared_from: Returns account users that the specified item type is being shared with and who are not sharing the specified item type with the user (only shared from the user). User (Share) >> Account user -shared_to_and_from: Returns account users that the specified item type is being shared with and who are sharing the specified item type with the user. User << (Share) >> Account user
startPosition String

If the response set exceeds Count, this can be used to specify that the method should return users starting at the specified index. The first index is 0, and should be used in the first GET call. Typically this number is a multiple of Count. If no value is specified, this defaults to be 0.
userIds String

A comma separated list of userIds for whom the shared item information is being requested.
callback module:api/AccountsApi~listSharedAccessCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSharedAccess

listSignatureProviders(accountId, callback)

Source:

Returns Account available signature providers for specified account.
Returns a list of signature providers that the specified account can use.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~listSignatureProvidersCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSignatureProviders

listUnsupportedFileTypes(accountId, callback)

Source:

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:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
callback module:api/AccountsApi~listUnsupportedFileTypesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/FileTypeList

unFavoriteTemplate(accountId, optsOrCallback, callback)

Source:

Unfavorite a template

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
favoriteTemplatesInfo module:model/FavoriteTemplatesInfo
callback module:api/AccountsApi~unFavoriteTemplateCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/FavoriteTemplatesInfo

updateAccountSignature(accountId, optsOrCallback, callback)

Source:

Updates a account signature.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
accountSignaturesInformation module:model/AccountSignaturesInformation
callback module:api/AccountsApi~updateAccountSignatureCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSignaturesInformation

updateAccountSignatureById(accountId, signatureId, optsOrCallback, callback)

Source:

Updates a account signature.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signatureId String

The ID of the signature being accessed.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
closeExistingSignature String
accountSignatureDefinition module:model/AccountSignatureDefinition
callback module:api/AccountsApi~updateAccountSignatureByIdCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSignature

updateAccountSignatureImage(accountId, signatureId, imageType, optsOrCallback, callback)

Source:

Sets a signature, initials, or stamps image.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
signatureId String

The ID of the signature being accessed.
imageType String

One of signature_image or initials_image.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
transparentPng String
callback module:api/AccountsApi~updateAccountSignatureImageCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSignature

updateAccountTabSettings(accountId, optsOrCallback, callback)

Source:

Modifies tab settings for specified account
This method modifies the tab types and tab functionality that is enabled for an account.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
tabAccountSettings module:model/TabAccountSettings
callback module:api/AccountsApi~updateAccountTabSettingsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TabAccountSettings

updateBrand(accountId, brandId, optsOrCallback, callback)

Source:

Updates an existing brand.
This method updates an account brand.
Note:* Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
brandId String

The unique identifier of a brand.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
replaceBrand String
brand module:model/Brand
callback module:api/AccountsApi~updateBrandCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Brand

updateBrandLogoByType(accountId, brandId, logoType, logoFileBytes, callback)

Source:

Put one branding logo.
This method updates a single brand logo.

You pass in the new version of the resource in the Content-Disposition header. Example:

Content-Disposition: form-data; name="file"; filename="logo.jpg"
Note:* Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID GUID.
brandId String

The ID of the brand.
logoType String

The type of logo. Valid values are:

  • primary
  • secondary
  • email
logoFileBytes Blob

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
callback module:api/AccountsApi~updateBrandLogoByTypeCallback

The callback function, accepting three arguments: error, data, response

updateBrandResourcesByContentType(accountId, brandId, resourceContentType, fileXml, callback)

Source:

Uploads a branding resource file.
This method updates a branding resource file.

You pass in the new version of the resource file in the Content-Disposition header. Example:

Content-Disposition: form-data; name="file"; filename="DocuSign_SigningResource_4328673.xml"
Note:* Branding for either signing or sending must be enabled for the account (canSelfBrandSend , canSelfBrandSign, or both of these account settings must be true).
Important:* Customizing resource files is an advanced branding configuration option which can significantly impact your account, and should be done only by someone with expertise in XML and HTML. The master resource files are subject to change without notice. If you customize your resource files, after each release, DocuSign recommends you review any changes and update your custom files as needed.

When you upload a modified resource file, only the elements that differ from the master resource file are saved as your resource file. Similarly, when you download your resource files, only the modified elements are included in the file.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID GUID.
brandId String

The ID of the brand.
resourceContentType String

The type of brand resource file that you are updating. Valid values are:

  • sending
  • signing
  • email
  • signing_captive
fileXml Object

Brand resource XML file.
callback module:api/AccountsApi~updateBrandResourcesByContentTypeCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/BrandResources

updateConsumerDisclosure(accountId, langCode, optsOrCallback, callback)

Source:

Update Consumer Disclosure.
Account administrators can use this method to perform the following tasks:

  • Customize values in the default disclosure.
  • Switch to a custom disclosure that uses your own text and HTML formatting.
  • Change values in your existing consumer disclosure.

To specify the signer language version of the disclosure that you are updating, use the optional langCode query parameter.
Note:* Only account administrators can use this method. Each time you change the disclosure content, all unsigned recipients of outstanding documents will be required to accept a new version.

Updating the default disclosure

When you update the default disclosure, you can edit all properties except for the following ones:

  • accountEsignId: This property is read-only.
  • custom: The default value is false. Editing this property causes the default disclosure to switch to a custom disclosure.
  • esignAgreement: This property is read-only.
  • esignText: You cannot edit this property when custom is set to false. The API returns a 200 OK HTTP response, but does not update the esignText.
  • Metadata properties: These properties are read-only.
    Note:* The text of the default disclosure is always in English.

Switching to a custom disclosure

To switch to a custom disclosure, set the custom property to true and customize the value for the eSignText property.

You can also edit all of the other properties except for the following ones:

  • accountEsignId: This property is read-only.

  • esignAgreement: This property is read-only.

  • Metadata properties: These properties are read-only.
    Note:* When you use a custom disclosure, you can create versions of it in different signer languages and se the langCode parameter to specify the signer language version that you are updating.
    Important:* When you switch from a default to a custom disclosure, note the following information:

  • You will not be able to return to using the default disclosure.

  • Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.

Updating a custom disclosure

When you update a custom disclosure, you can update all of the properties except for the following ones:

  • accountEsignId: This property is read-only.
  • esignAgreement: This property is read-only.
  • Metadata properties: These properties are read-only.
    Important:* Only the disclosure for the currently selected signer language is saved. DocuSign will not automatically translate your custom disclosure. You must create a disclosure for each language that your signers use.
Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
langCode String

The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Armenian (hy), 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 Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (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) and Vietnamese (vi). Additionally, the value can be set to �browser� to automatically detect the browser language being used by the viewer and display the disclosure in that language.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
includeMetadata String
consumerDisclosure module:model/ConsumerDisclosure
callback module:api/AccountsApi~updateConsumerDisclosureCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ConsumerDisclosure

updateCustomField(accountId, customFieldId, optsOrCallback, callback)

Source:

Updates an existing account custom field.
This method updates an existing account custom field.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
customFieldId String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
applyToTemplates String
customField module:model/CustomField
callback module:api/AccountsApi~updateCustomFieldCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/CustomFields

updateENoteConfiguration(accountId, optsOrCallback, callback)

Source:

Updates configuration information for the eNote eOriginal integration.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
eNoteConfiguration module:model/ENoteConfiguration
callback module:api/AccountsApi~updateENoteConfigurationCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/ENoteConfiguration

updateEnvelopePurgeConfiguration(accountId, optsOrCallback, callback)

Source:

Updates envelope purge configuration.
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:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
envelopePurgeConfiguration module:model/EnvelopePurgeConfiguration
callback module:api/AccountsApi~updateEnvelopePurgeConfigurationCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/EnvelopePurgeConfiguration

updateFavoriteTemplate(accountId, optsOrCallback, callback)

Source:

Favorites a template

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
favoriteTemplatesInfo module:model/FavoriteTemplatesInfo
callback module:api/AccountsApi~updateFavoriteTemplateCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/FavoriteTemplatesInfo

updateNotificationDefaults(accountId, optsOrCallback, callback)

Source:

Updates default user level settings for a specified account
This method changes the default settings for the email notifications that signers and senders receive about envelopes.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
notificationDefaults module:model/NotificationDefaults
callback module:api/AccountsApi~updateNotificationDefaultsCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/NotificationDefaults

updatePasswordRules(accountId, optsOrCallback, callback)

Source:

Update the password rules
This method updates the password rules for an account.
Note:* To update the password rules for an account, you must be an account administrator.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
accountPasswordRules module:model/AccountPasswordRules
callback module:api/AccountsApi~updatePasswordRulesCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountPasswordRules

updatePermissionProfile(accountId, permissionProfileId, optsOrCallback, callback)

Source:

Updates a permission profile within the specified account.
This method updates an account permission profile.

Related topics

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
permissionProfileId String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
include String
permissionProfile module:model/PermissionProfile
callback module:api/AccountsApi~updatePermissionProfileCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/PermissionProfile

updateSettings(accountId, optsOrCallback, callback)

Source:

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

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
accountSettingsInformation module:model/AccountSettingsInformation
callback module:api/AccountsApi~updateSettingsCallback

The callback function, accepting three arguments: error, data, response

updateSharedAccess(accountId, optsOrCallback, callback)

Source:

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

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
itemType String
preserveExistingSharedAccess String
userIds String
accountSharedAccess module:model/AccountSharedAccess
callback module:api/AccountsApi~updateSharedAccessCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/AccountSharedAccess

updateUserAuthorization(accountId, userId, authorizationId, optsOrCallback, callback)

Source:

Updates the user authorization

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
userId String

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
authorizationId String
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
userAuthorizationUpdateRequest module:model/UserAuthorizationUpdateRequest
callback module:api/AccountsApi~updateUserAuthorizationCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/UserAuthorization

updateWatermark(accountId, optsOrCallback, callback)

Source:

Update watermark information.

Parameters:
Name Type Description
accountId String

The external account number (int) or account ID Guid.
optsOrCallback Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties
Name Type Description
watermark module:model/Watermark
callback module:api/AccountsApi~updateWatermarkCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/Watermark

Type Definitions

_deleteCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the _delete operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createAccountSignaturesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createAccountSignatures operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSignaturesInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createBrandCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createBrand operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/BrandsResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the create operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/NewAccountSummary

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createCustomFieldCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createCustomField operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/CustomFields

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createPermissionProfileCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createPermissionProfile operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/PermissionProfile

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createUserAuthorizationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createUserAuthorization operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/UserAuthorization

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createUserAuthorizationsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the createUserAuthorizations operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/UserAuthorizationsResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteAccountSignatureCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteAccountSignature operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteAccountSignatureImageCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteAccountSignatureImage operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSignature

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteBrandCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteBrand operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteBrandLogoByTypeCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteBrandLogoByType operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteBrandsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteBrands operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/BrandsResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteCaptiveRecipientCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteCaptiveRecipient operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/CaptiveRecipientInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteCustomFieldCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteCustomField operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteENoteConfigurationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteENoteConfiguration operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deletePermissionProfileCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deletePermissionProfile operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteUserAuthorizationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteUserAuthorization operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

deleteUserAuthorizationsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the deleteUserAuthorizations operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/UserAuthorizationsDeleteResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getAccountIdentityVerificationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getAccountIdentityVerification operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountIdentityVerificationResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getAccountInformationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getAccountInformation operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getAccountSignatureCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getAccountSignature operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSignature

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getAccountSignatureImageCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getAccountSignatureImage operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data Object

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getAccountSignaturesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getAccountSignatures operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSignaturesInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getAccountTabSettingsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getAccountTabSettings operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/TabAccountSettings

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getAgentUserAuthorizationsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getAgentUserAuthorizations operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/UserAuthorizations

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getAllPaymentGatewayAccountsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getAllPaymentGatewayAccounts operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/PaymentGatewayAccountsInfo

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getBillingChargesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getBillingCharges operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/BillingChargeResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getBrandCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getBrand operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Brand

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getBrandExportFileCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getBrandExportFile operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getBrandLogoByTypeCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getBrandLogoByType operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data Object

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getBrandResourcesByContentTypeCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getBrandResourcesByContentType operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getBrandResourcesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getBrandResources operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/BrandResourcesList

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getConsumerDisclosureCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getConsumerDisclosure operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/ConsumerDisclosure

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getConsumerDisclosureDefaultCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getConsumerDisclosureDefault operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/ConsumerDisclosure

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getENoteConfigurationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getENoteConfiguration operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/ENoteConfiguration

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getEnvelopePurgeConfigurationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getEnvelopePurgeConfiguration operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/EnvelopePurgeConfiguration

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getFavoriteTemplatesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getFavoriteTemplates operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/FavoriteTemplatesInfo

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getNotificationDefaultsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getNotificationDefaults operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/NotificationDefaults

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getPasswordRules_0Callback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getPasswordRules_0 operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/UserPasswordRules

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getPasswordRulesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getPasswordRules operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountPasswordRules

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getPermissionProfileCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getPermissionProfile operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/PermissionProfile

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getPrincipalUserAuthorizationsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getPrincipalUserAuthorizations operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/UserAuthorizations

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getProvisioningCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getProvisioning operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/ProvisioningInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getSupportedLanguagesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getSupportedLanguages operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/SupportedLanguages

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getUserAuthorizationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getUserAuthorization operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/UserAuthorization

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getWatermarkCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getWatermark operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Watermark

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getWatermarkPreviewCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the getWatermarkPreview operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Watermark

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listBrandsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listBrands operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/BrandsResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listCustomFieldsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listCustomFields operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/CustomFields

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listPermissionsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listPermissions operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/PermissionProfileInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listRecipientNamesByEmailCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listRecipientNamesByEmail operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/RecipientNamesResponse

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listSettingsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listSettings operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSettingsInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listSharedAccessCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listSharedAccess operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSharedAccess

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listSignatureProvidersCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listSignatureProviders operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSignatureProviders

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listUnsupportedFileTypesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the listUnsupportedFileTypes operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/FileTypeList

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

unFavoriteTemplateCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the unFavoriteTemplate operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/FavoriteTemplatesInfo

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateAccountSignatureByIdCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateAccountSignatureById operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSignature

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateAccountSignatureCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateAccountSignature operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSignaturesInformation

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateAccountSignatureImageCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateAccountSignatureImage operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSignature

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateAccountTabSettingsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateAccountTabSettings operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/TabAccountSettings

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateBrandCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateBrand operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Brand

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateBrandLogoByTypeCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateBrandLogoByType operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateBrandResourcesByContentTypeCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateBrandResourcesByContentType operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/BrandResources

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateConsumerDisclosureCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateConsumerDisclosure operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/ConsumerDisclosure

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateCustomFieldCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateCustomField operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/CustomFields

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateENoteConfigurationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateENoteConfiguration operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/ENoteConfiguration

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateEnvelopePurgeConfigurationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateEnvelopePurgeConfiguration operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/EnvelopePurgeConfiguration

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateFavoriteTemplateCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateFavoriteTemplate operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/FavoriteTemplatesInfo

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateNotificationDefaultsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateNotificationDefaults operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/NotificationDefaults

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updatePasswordRulesCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updatePasswordRules operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountPasswordRules

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updatePermissionProfileCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updatePermissionProfile operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/PermissionProfile

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateSettingsCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateSettings operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data

This operation does not return a value.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateSharedAccessCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateSharedAccess operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/AccountSharedAccess

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateUserAuthorizationCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateUserAuthorization operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/UserAuthorization

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateWatermarkCallback(error, data, If)

Source:

(Optional) Callback function to receive the result of the updateWatermark operation. If none specified a Promise will be returned.

Parameters:
Name Type Description
error String

Error message, if any.
data module:model/Watermark

The data returned by the service call.
If String

a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.