Users: getSettings

Retrieves a list of the account settings and email notification information for the specified user.

The response returns the account setting name/value information and the email notification settings for the specified user. For more information about the different user settings, see User Settings.

Request

HTTP request

GET /v2.1/accounts/{accountId}/users/{userId}/settings

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

userIdstring

The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, userId can represent another user whom the Administrator is accessing.

Responses

CodeDescriptionReference
200

Successful response.

userSettingsInformation
400

Error encountered.

errorDetails

SDK Method

Users::getSettings

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

localePolicy

addressFormatstring

addressFormatMetadatasettingsMetadata

allowRegionstring

calendarTypestring

calendarTypeMetadatasettingsMetadata

cultureNamestring

cultureNameMetadatasettingsMetadata

currencyCodestring

The currency code for the account, based on the ISO 4217 currency code.

currencyCodeMetadatasettingsMetadata

Metadata that indicates whether the currencyCode property is editable.

currencyNegativeFormatstring

currencyNegativeFormatMetadatasettingsMetadata

currencyPositiveFormatstring

currencyPositiveFormatMetadatasettingsMetadata

customDateFormatstring

customSignDateFormatstring

customSignTimeFormatstring

customTimeFormatstring

dateFormatstring

dateFormatMetadatasettingsMetadata

effectiveAddressFormatstring

effectiveCalendarTypestring

effectiveCurrencyCodestring

effectiveCurrencyNegativeFormatstring

effectiveCurrencyPositiveFormatstring

effectiveCustomDateFormatstring

effectiveCustomTimeFormatstring

effectiveDateFormatstring

effectiveInitialFormatstring

effectiveNameFormatstring

effectiveTimeFormatstring

effectiveTimeZonestring

initialFormatstring

initialFormatMetadatasettingsMetadata

nameFormatstring

nameFormatMetadatasettingsMetadata

signDateFormatstring

The format for the signature date. Valid values are:

  • d/M/yyyy
  • dd-MM-yy
  • dd-MMM-yy
  • dd-MM-yyyy
  • dd.MM.yyyy
  • dd-MMM-yyyy
  • dd MMMM yyyy
  • M/d/yyyy
  • MM-dd-yyyy
  • MM/dd/yyyy
  • MM/dd/yy
  • MMM-dd-yyyy
  • MMM d, yyyy
  • MMMM d, yyyy
  • yyyy-MM-dd
  • yyyy-MMM-dd
  • yyyy/MM/dd
  • yyyy MMMM d

signDateFormatMetadatasettingsMetadata

Metadata that indicates whether the signDateFormat property is editable.

signTimeFormatstring

The format for the signature time. Valid values are:

  • none
  • HH:mm
  • h:mm
  • HH:mm:ss
  • h:mm:ss

signTimeFormatMetadatasettingsMetadata

Metadata that indicates whether the signTimeFormat property is editable.

timeFormatstring

timeFormatMetadatasettingsMetadata

timeZonestring

timeZoneMetadatasettingsMetadata

sealIdentifier

sealDisplayNamestring

sealNamestring

senderEmailNotifications

Contains the settings for the email notifications that senders receive about the envelopes that they send.

changedSignerstring

When set to true, the sender receives an email notification if the signer changes.

commentsOnlyPrivateAndMentionstring

When set to true, the user receives only comments that mention their own user name.

commentsReceiveAllstring

When set to true, the user receives all comments.

deliveryFailedstring

When set to true, the sender receives an email notification if envelope delivery fails.

envelopeCompletestring

When set to true, the user receives an email notification when the envelope has been completed.

offlineSigningFailedstring

When set to true, the user receives an email notification if offline signing failed.

purgeDocumentsstring

When set to true, the user receives an email notification when a document purge occurs.

recipientViewedstring

When set to true, the sender receives notification that a recipient viewed the envelope.

senderEnvelopeDeclinedstring

When set to true, the sender receives notification that the envelope was declined.

withdrawnConsentstring

When set to true, the user receives an email notification if consent is withdrawn.

settingsMetadata

Metadata that indicates whether a property is editable and describes setting-specific options.

is21CFRPart11string

When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

uiHintstring

Reserved for DocuSign.

uiOrderstring

Reserved for DocuSign.

uiTypestring

Reserved for DocuSign.

signerEmailNotifications

An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created.

agentNotificationstring

When set to true, the user receives agent notification emails.

carbonCopyNotificationstring

When set to true, the user receives notifications of carbon copy deliveries.

certifiedDeliveryNotificationstring

When set to true, the user receives notifications of certified deliveries.

commentsOnlyPrivateAndMentionstring

When set to true, the user receives only comments that mention their own user name.

commentsReceiveAllstring

When set to true, the user receives all comments.

documentMarkupActivationstring

When set to true, the user receives notification that document markup has been activated.

envelopeActivationstring

When set to true, the user receives notification that the envelope has been activated.

envelopeCompletestring

When set to true, the user receives an email notification when the envelope has been completed.

envelopeCorrectedstring

When set to true, the user receives notification that the envelope has been corrected.

envelopeDeclinedstring

When set to true, the user receives notification that the envelope has been declined.

envelopeVoidedstring

When set to true, the user receives notification that the envelope has been voided.

faxReceivedstring

Reserved for DocuSign.

offlineSigningFailedstring

When set to true, the user receives an email notification if offline signing failed.

purgeDocumentsstring

When set to true, the user receives an email notification when a document purge occurs.

reassignedSignerstring

When set to true, the user receives notification that the envelope has been reassigned.

whenSigningGroupMemberstring

When set to true, the user receives notification that he or she is a member of the signing group.

userAccountManagementGranularInformation

Describes which account management capabilities a user has.

canManageAccountSecuritySettingsstring

True if the user can manage account security settings.

canManageAccountSecuritySettingsMetadatasettingsMetadata

canManageAccountSettingsstring

True if the user can manage account settings.

canManageAccountSettingsMetadatasettingsMetadata

canManageAdminsstring

True if the user can manage administrators.

canManageAdminsMetadatasettingsMetadata

Metadata that indicates whether the canManageAdmins property is editable.

canManageReportingstring

True if the user can manage reporting.

canManageReportingMetadatasettingsMetadata

canManageSharingstring

True if the user can manage sharing.

canManageSharingMetadatasettingsMetadata

Metadata that indicates whether the canManageSharing property is editable.

canManageSigningGroupsstring

True if the user can manage signing groups.

canManageSigningGroupsMetadatasettingsMetadata

canManageUsersstring

True if the user can manage users.

canManageUsersMetadatasettingsMetadata

Metadata that indicates whether the canManageUsers property is editable.

userSettingsInformation

Data that describes settings for a user. Some elements of this object have a metadata property, which includes the following:

  • rights: The calling users permissions to edit this setting (can be editable or read_only)
  • uiHint: Internally used to build UIs (can be available or hidden)
  • options: The values supported for this setting (not all settings have this element)

accountManagementGranularuserAccountManagementGranularInformation

Describes which account management capabilities a user has.

adminOnlystring

Reserved for DocuSign.

adminOnlyMetadatasettingsMetadata

Reserved for DocuSign.

allowAutoTaggingstring

allowEnvelopeTransferTostring

Boolean value that indicates whether the user can participate in envelope transfers on the account.

allowEnvelopeTransferToMetadatasettingsMetadata

Reserved for DocuSign.

allowEsealRecipientsstring

allowEsealRecipientsMetadatasettingsMetadata

allowPowerFormsAdminToAccessAllPowerFormEnvelopestring

allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadatasettingsMetadata

allowRecipientLanguageSelectionstring

When true, this user can set the language used in the standard email format for a recipient when creating an envelope.

allowRecipientLanguageSelectionMetadatasettingsMetadata

Metadata for allowRecipientLanguageSelection.

allowSendOnBehalfOfstring

When true, this user can send envelopes "on behalf of" other users through the API.

allowSendOnBehalfOfMetadatasettingsMetadata

Metadata for allowSendOnBehalfOf.

allowSupplementalDocumentsstring

When true, this user can include supplemental documents.

allowSupplementalDocumentsMetadatasettingsMetadata

Metadata that indicates whether the allowSupplementalDocuments property is editable.

anchorTagVersionedPlacementEnabledstring

Valid values are:

  • system_default
  • off
  • on

apiAccountWideAccessstring

When true, indicates that this user can send envelope-specific API requests on the account.

apiAccountWideAccessMetadatasettingsMetadata

Metadata for apiAccountWideAccess.

apiCanExportACstring

When true, this user can export authoritative copy for the account.

apiCanExportACMetadatasettingsMetadata

bulkSendstring

When true, this user can use the bulk send feature for the account.

bulkSendMetadatasettingsMetadata

Metadata that indicates whether the bulkSend property is editable.

canChargeAccountstring

Reserved for DocuSign.

canChargeAccountMetadatasettingsMetadata

Reserved for DocuSign.

canEditSharedAddressbookstring

When true, this user can edit the shared address book for the account.

canEditSharedAddressbookMetadatasettingsMetadata

canLockEnvelopesstring

canLockEnvelopesMetadatasettingsMetadata

canManageAccountstring

When true, this user is an administrator for the account.

canManageAccountMetadatasettingsMetadata

canManageDistributorstring

Reserved for DocuSign.

canManageDistributorMetadatasettingsMetadata

canManageTemplatesstring

When true, this user can manage templates for the account.

canManageTemplatesMetadatasettingsMetadata

canSendAPIRequestsstring

When true, this user can send API requests on the account.

canSendAPIRequestsMetadatasettingsMetadata

canSendEnvelopestring

When true, this user can send envelopes on the account.

canSendEnvelopeMetadatasettingsMetadata

canSignEnvelopestring

When true, this user can sign envelopes.

canSignEnvelopeMetadatasettingsMetadata

canUseScratchpadstring

canUseScratchpadMetadatasettingsMetadata

canUseSmartContractsstring

canUseSmartContractsMetadatasettingsMetadata

disableDocumentUploadstring

When true, this user is prohibited from uploading documents during sending.

disableDocumentUploadMetadatasettingsMetadata

Metadata that indicates whether the disableDocumentUpload property is editable.

disableOtherActionsstring

When true, this user can access the Other Actions menu.

disableOtherActionsMetadatasettingsMetadata

Metadata that indicates whether the disableOtherActions property is editable.

enableDSProstring

Reserved for DocuSign.

enableDSProMetadatasettingsMetadata

Metadata that indicates whether the enableDSPro property is editable.

enableSequentialSigningAPIstring

When true, the account can define the routing order of recipients for envelopes sent using the DocuSign API.

enableSequentialSigningAPIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningAPI property is editable.

enableSequentialSigningUIstring

When true, the account can define the routing order of recipients for envelopes sent using the DocuSign application.

enableSequentialSigningUIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningUI property is editable.

enableSignerAttachmentsstring

When true, this user can use the signing attachments feature.

enableSignerAttachmentsMetadatasettingsMetadata

Metadata that indicates whether the enableSignerAttachments property is editable.

enableSignOnPaperOverridestring

When true, this user can override the Sign on Paper account setting, which specifies whether signers can sign documents on paper as an option to signing electronically.

enableSignOnPaperOverrideMetadatasettingsMetadata

Metadata that indicates whether the enableSignOnPaperOverride property is editable.

enableTransactionPointstring

Reserved for DocuSign.

enableTransactionPointMetadatasettingsMetadata

Metadata that indicates whether the enableTransactionPoint property is editable.

enableVaultingstring

When true, Vaulting is enabled for the account.

enableVaultingMetadatasettingsMetadata

Metadata that indicates whether the enableVaulting property is editable.

expressSendOnlystring

localestring

The user's locale code:

  • zh_CN
  • zh_TW
  • nl
  • en
  • fr
  • de
  • it
  • ja
  • ko
  • pt
  • pt_BR
  • ru
  • es

localeMetadatasettingsMetadata

localePolicylocalePolicy

Reserved for DocuSign.

manageClickwrapsModestring

manageClickwrapsModeMetadatasettingsMetadata

modifiedBystring

User ID (GUID) of the user who last modified this user record.

modifiedByMetadatasettingsMetadata

modifiedDatestring

Most recent date on which this user record was modified.

modifiedDateMetadatasettingsMetadata

modifiedPagestring

Note referencing the page that modified this user record.

modifiedPageMetadatasettingsMetadata

newSendUIstring

Reserved for DocuSign.

newSendUIMetadatasettingsMetadata

powerFormModestring

Indicates the Power Form mode setting for the user:

  • none
  • admin
  • user

powerFormModeMetadatasettingsMetadata

recipientViewedNotificationstring

When true, this user receives notifications when envelopes are viewed.

recipientViewedNotificationMetadatasettingsMetadata

sealIdentifiers[sealIdentifier]

selfSignedRecipientEmailDocumentstring

Valid values are:

  • include_pdf
  • include_link

selfSignedRecipientEmailDocumentMetadatasettingsMetadata

Metadata that indicates whether the selfSignedRecipientEmailDocument property is editable.

senderEmailNotificationssenderEmailNotifications

An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign.

The user inherits the default account sender email notification settings when the user is created. The email notifications are:

  • envelopeComplete
  • changedSigner
  • senderEnvelopeDeclined
  • withdrawnConsent
  • recipientViewed
  • deliveryFailed

signerEmailNotificationssignerEmailNotifications

An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created.

supplementalDocumentIncludeInDownloadstring

When true, this user gets supplemental documents when downloading documents.

supplementalDocumentsMustAcceptstring

When true, this user must accept supplemental documents.

supplementalDocumentsMustAcceptMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustAccept property is editable.

supplementalDocumentsMustReadstring

When true, this user must read supplemental documents.

supplementalDocumentsMustReadMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustRead property is editable.

supplementalDocumentsMustViewstring

When true, this user must view supplemental documents.

supplementalDocumentsMustViewMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustView property is editable.

templateActiveCreationstring

templateActiveCreationMetadatasettingsMetadata

templateApplyNotifystring

templateApplyNotifyMetadatasettingsMetadata

templateAutoMatchingstring

templateAutoMatchingMetadatasettingsMetadata

templateMatchingSensitivitystring

Percentage used when matching templates.

templateMatchingSensitivityMetadatasettingsMetadata

templatePageLevelMatchingstring

When true, users see template matching functionality.

templatePageLevelMatchingMetadatasettingsMetadata

timezoneDSTstring

When true, daylight savings time is in effect for this user's time zone.

timezoneDSTMetadatasettingsMetadata

timezoneMaskstring

timezoneMaskMetadatasettingsMetadata

timezoneOffsetstring

The timezone offset for the user. Valid values:

  • tz_01_afghanistan
  • tz_02_alaskan
  • tz_03_arab
  • tz_04_arabian
  • tz_05_arabic
  • tz_06_argentina
  • tz_07_atlantic
  • tz_08_aus_central
  • tz_09_aus_eastern
  • tz_10_azerbaijan
  • tz_11_azores
  • tz_12_bangladesh
  • tz_13_canada_central
  • tz_14_cape_verde
  • tz_15_caucasus
  • tz_16_central_australia
  • tz_17_central_america
  • tz_18_central_asia
  • tz_19_central_brazilian
  • tz_20_central_europe
  • tz_21_central_european
  • tz_22_central_pacific
  • tz_23_central
  • tz_24_central_mexico
  • tz_25_china
  • tz_26_dateline
  • tz_27_east_africa
  • tz_28_east_australia
  • tz_29_east_europe
  • tz_30_east_south_america
  • tz_31_eastern
  • tz_32_egypt
  • tz_33_ekaterinburg
  • tz_34_fiji
  • tz_35_fli
  • tz_36_georgian
  • tz_37_gmt
  • tz_38_greenland
  • tz_39_greenwich
  • tz_40_gtb
  • tz_41_hawaiian
  • tz_42_india
  • tz_43_iran
  • tz_44_israel
  • tz_45_jordan
  • tz_46_kaliningrad
  • tz_47_kamchatka
  • tz_48_korea
  • tz_49_magadan
  • tz_50_mauritius
  • tz_51_mid_atlantic
  • tz_52_middle_east
  • tz_53_montevideo
  • tz_54_morocco
  • tz_55_mountain
  • tz_56_mountain_mexico
  • tz_57_myanmar
  • tz_58_north_central_asia
  • tz_59_namibia
  • tz_60_nepal
  • tz_61_new_zealand
  • tz_62_new_foundland
  • tz_63_north_asia_east
  • tz_64_north_asia
  • tz_65_pacific_sa
  • tz_66_pacific
  • tz_67_pacific_mexico
  • tz_68_pakistan
  • tz_69_paraguay
  • tz_70_romance
  • tz_71_russian
  • tz_72_sa_eastern
  • tz_73_sa_pacific
  • tz_74_sa_western
  • tz_75_samoa
  • tz_76_se_asia
  • tz_77_singapore
  • tz_78_south_africa
  • tz_79_sriLanka
  • tz_80_syria
  • tz_81_taipei
  • tz_82_tasmania
  • tz_83_tokyo
  • tz_84_tonga
  • tz_85_turkey
  • tz_86_ulaanbaatar
  • tz_87_us_eastern
  • tz_88_us_mountain
  • tz_89_venezuela
  • tz_90_vladivostok
  • tz_91_west_australia
  • tz_92_west_central_africa
  • tz_93_west_europe
  • tz_94_west_asia
  • tz_95_west_pacific
  • tz_96_yakutsk

timezoneOffsetMetadatasettingsMetadata

timezoneSendingPrefstring

Reserved for DocuSign.

timezoneSendingPrefMetadatasettingsMetadata

timezoneSigningPrefstring

Reserved for DocuSign.

timezoneSigningPrefMetadatasettingsMetadata

transactionPointSiteNameURLstring

Reserved for DocuSign.

transactionPointSiteNameURLMetadatasettingsMetadata

transactionPointUserNamestring

Reserved for DocuSign.

transactionPointUserNameMetadatasettingsMetadata

vaultingModestring

Indicates the specified Vaulting mode:

  • none
  • estored
  • electronic_original

vaultingModeMetadatasettingsMetadata

Metadata that indicates whether the vaultingMode property is editable.

Examples

Generic JSON Response

Response
{
  "userSettings": [
    {}
  ],
  "accountManagementGranular": {
    "canManageUsers": "sample string 1",
    "canManageAdmins": "sample string 2",
    "canManageGroups": "sample string 3",
    "canManageSharing": "sample string 4",
    "canManageUsersMetadata": {
      "rights": "sample string 1",
      "uiHint": "sample string 2",
      "uiType": "sample string 3",
      "uiOrder": "sample string 4",
      "is21CFRPart11": "sample string 5",
      "options": [
        "sample string 1"
      ]
    },
    "canManageAdminsMetadata": {},
    "canManageGroupsMetadata": {},
    "canManageSharingMetadata": {}
  },
  "signerEmailNotifications": {
    "envelopeActivation": "sample string 1",
    "envelopeComplete": "sample string 2",
    "carbonCopyNotification": "sample string 3",
    "certifiedDeliveryNotification": "sample string 4",
    "envelopeDeclined": "sample string 5",
    "envelopeVoided": "sample string 6",
    "envelopeCorrected": "sample string 7",
    "reassignedSigner": "sample string 8",
    "purgeDocuments": "sample string 9",
    "faxReceived": "sample string 10",
    "documentMarkupActivation": "sample string 11",
    "agentNotification": "sample string 12",
    "offlineSigningFailed": "sample string 13",
    "whenSigningGroupMember": "sample string 14",
    "commentsReceiveAll": "sample string 15",
    "commentsOnlyPrivateAndMention": "sample string 16"
  },
  "senderEmailNotifications": {
    "envelopeComplete": "sample string 1",
    "changedSigner": "sample string 2",
    "senderEnvelopeDeclined": "sample string 3",
    "withdrawnConsent": "sample string 4",
    "recipientViewed": "sample string 5",
    "deliveryFailed": "sample string 6",
    "offlineSigningFailed": "sample string 7",
    "commentsReceiveAll": "sample string 8",
    "commentsOnlyPrivateAndMention": "sample string 9"
  }
}
Generic XML Response

Response
<userSettingsInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <accountManagementGranular>
    <canManageAdmins>sample string 2</canManageAdmins>
    <canManageAdminsMetadata />
    <canManageGroups>sample string 3</canManageGroups>
    <canManageGroupsMetadata />
    <canManageSharing>sample string 4</canManageSharing>
    <canManageSharingMetadata />
    <canManageUsers>sample string 1</canManageUsers>
    <canManageUsersMetadata>
      <is21CFRPart11>sample string 5</is21CFRPart11>
      <options>
        <string>sample string 1</string>
      </options>
      <rights>sample string 1</rights>
      <uiHint>sample string 2</uiHint>
      <uiOrder>sample string 4</uiOrder>
      <uiType>sample string 3</uiType>
    </canManageUsersMetadata>
  </accountManagementGranular>
  <senderEmailNotifications>
    <changedSigner>sample string 2</changedSigner>
    <commentsOnlyPrivateAndMention>sample string 9</commentsOnlyPrivateAndMention>
    <commentsReceiveAll>sample string 8</commentsReceiveAll>
    <deliveryFailed>sample string 6</deliveryFailed>
    <envelopeComplete>sample string 1</envelopeComplete>
    <offlineSigningFailed>sample string 7</offlineSigningFailed>
    <recipientViewed>sample string 5</recipientViewed>
    <senderEnvelopeDeclined>sample string 3</senderEnvelopeDeclined>
    <withdrawnConsent>sample string 4</withdrawnConsent>
  </senderEmailNotifications>
  <signerEmailNotifications>
    <agentNotification>sample string 12</agentNotification>
    <carbonCopyNotification>sample string 3</carbonCopyNotification>
    <certifiedDeliveryNotification>sample string 4</certifiedDeliveryNotification>
    <commentsOnlyPrivateAndMention>sample string 16</commentsOnlyPrivateAndMention>
    <commentsReceiveAll>sample string 15</commentsReceiveAll>
    <documentMarkupActivation>sample string 11</documentMarkupActivation>
    <envelopeActivation>sample string 1</envelopeActivation>
    <envelopeComplete>sample string 2</envelopeComplete>
    <envelopeCorrected>sample string 7</envelopeCorrected>
    <envelopeDeclined>sample string 5</envelopeDeclined>
    <envelopeVoided>sample string 6</envelopeVoided>
    <faxReceived>sample string 10</faxReceived>
    <offlineSigningFailed>sample string 13</offlineSigningFailed>
    <purgeDocuments>sample string 9</purgeDocuments>
    <reassignedSigner>sample string 8</reassignedSigner>
    <whenSigningGroupMember>sample string 14</whenSigningGroupMember>
  </signerEmailNotifications>
  <userSettings>
    <nameValue />
  </userSettings>
</userSettingsInformation> 
}} />