v1

latestSwagger 2.02026-07-134146194.6 MB
Users

Updates the user account settings for a specified user.

Updates the account settings list and email notification types for the specified user.

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

Path parameters

accountIdstring required

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

userIdstring required

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.

Query parameters

allow_all_languagesstring

Request body

accountAgreementsAccessTypestring
adminOnlystring

Reserved for Docusign.

allowAccessToAllAccountAgreementsstring
allowAutoTaggingstring

When true, the API returns suggested tabs for documents for this user.

allowedDocumentTemplateLibraryAccessstring
allowedOrchestrationAccessstring
allowEnvelopeTransferTostring

When true, this user can participate in envelope transfers on the account.

allowEsealRecipientsstring

When true, this user can create electronic seal recipients.

allowPowerFormsAdminToAccessAllPowerFormEnvelopestring

When true and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is false.

allowRecipientLanguageSelectionstring

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

allowSendOnBehalfOfstring

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

allowSupplementalDocumentsstring

When true, this user can include supplemental documents.

allowTransactionsstring
anchorTagVersionedPlacementEnabledstring

Reserved for Docusign.

apiAccountWideAccessstring

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

apiCanExportACstring

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

bulkSendstring

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

canBulkUploadAgreementsstring
canChargeAccountstring

Reserved for Docusign.

canCreateTransactionstring
canDeleteDocumentsInTransactionstring
canDeleteTransactionstring
canEditSharedAddressbookstring

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

canLockEnvelopesstring

Reserved for Docusign.

canManageAccountstring

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

canManageAgreementPartiesstring
canManageDistributorstring

Reserved for Docusign.

canManageTemplatesstring

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

canSendAPIRequestsstring

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

canSendEnvelopestring

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

canSendEnvelopesViaSMSstring
canSignEnvelopestring

When true, this user can sign envelopes.

canUseScratchpadstring

When true, this user can use a scratchpad to edit information.

canUseSmartContractsstring

Reserved for Docusign.

disableDocumentUploadstring

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

disableOtherActionsstring

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

enableDSProstring

Reserved for Docusign.

enableKeyTermsSuggestionsByDocumentTypestring
enableSequentialSigningAPIstring

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

Note: Only SysAdmin users can change this setting.

enableSequentialSigningUIstring

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

Note: Only SysAdmin users can change this setting.

enableSignerAttachmentsstring

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

enableSignOnPaperOverridestring

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

Note: Only Admin users can change this setting.

enableTransactionPointstring

Reserved for Docusign.

enableVaultingstring

When true, Vaulting is enabled for the account.

expressSendOnlystring

When false, this user can apply tabs to documents during the sending experience.

isManagedByScimstring
isMembershipManagedByScimstring
localestring

The user's locale code. Valid values are:

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

When true, this user can create and manage Clickwraps.

modifiedBystring

The user ID (GUID) of the user who last modified this user record. This property is read-only.

modifiedDatestring

The date on which this user record was last modified.

modifiedPagestring

Note referencing the page that modified this user record.

newSendUIstring

Reserved for Docusign.

powerFormModestring

Indicates the Power Form mode setting for the user:

  • none
  • admin
  • user
recipientViewedNotificationstring

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

selfSignedRecipientEmailDocumentstring

Sets how self-signed documents are presented to the email recipients. Valid values are:

  • include_pdf: A PDF of the completed document is attached to the email.
  • include_link: A secure link to the self-signed documents is included in the email.

Note: Only Admin users can change this setting.

supplementalDocumentIncludeInDownloadstring

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

supplementalDocumentsMustAcceptstring

When true, this user must accept supplemental documents.

supplementalDocumentsMustReadstring

When true, this user must both view and accept supplemental documents.

supplementalDocumentsMustViewstring

When true, this user must view supplemental documents.

templateActiveCreationstring

When true, a new template is created each time the user sends an envelope.

templateApplyNotifystring

When true, the system notifies this user before applying a matching template.

templateAutoMatchingstring

When true, the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from.

templateMatchingSensitivitystring

Percentage used when matching templates.

templatePageLevelMatchingstring

When true, users see template matching functionality.

timezoneDSTstring

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

timezoneMaskstring

The custom DateTime format setting for this user.

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
timezoneSendingPrefstring

Reserved for Docusign.

timezoneSigningPrefstring

Reserved for Docusign.

transactionPointSiteNameURLstring

Reserved for Docusign.

transactionPointUserNamestring

Reserved for Docusign.

vaultingModestring

Indicates the specified Vaulting mode:

  • none
  • estored
  • electronic_original
webFormsstring

Response

Successful response.