Updates the user account settings for a specified user
Updates the account settings list and email notification types for the specified user.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
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
Request Body
application/json
Properties that configure the 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 beeditableorread_only)uiHint: Internally used to build UIs (can beavailableorhidden)options: The values supported for this setting (not all settings have this element)
Describes which account management capabilities a user has.
Reserved for Docusign.
When true, the API returns suggested tabs for documents for this user.
When true, this user can participate in envelope transfers on the account.
When true, this user can create electronic seal recipients.
When true and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is false.
When true, this user can set the language used in the standard email format for a recipient when creating an envelope.
When true, this user can send envelopes "on behalf of" other users through the API.
When true, this user can include supplemental documents.
Reserved for Docusign.
When true, indicates that this user can send envelope-specific API requests on the account.
When true, this user can export authoritative copy for the account.
When true, this user can use the bulk send feature for the account.
Reserved for Docusign.
When true, this user can edit the shared address book for the account.
Reserved for Docusign.
When true, this user is an administrator for the account.
Reserved for Docusign.
When true, this user can manage templates for the account.
When true, this user can send API requests on the account.
When true, this user can send envelopes on the account.
When true, this user can sign envelopes.
When true, this user can use a scratchpad to edit information.
Reserved for Docusign.
When true, this user is prohibited from uploading documents during sending.
When true, this user can access the Other Actions menu.
Reserved for Docusign.
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.
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.
When true, this user can use the signing attachments feature.
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.
Reserved for Docusign.
When true, Vaulting is enabled for the account.
When false, this user can apply tabs to documents during the sending experience.
The user's locale code. Valid values are:
zh_CNzh_TWnlenfrdeitjakoptpt_BRrues
When true, this user can create and manage Clickwraps.
The user ID (GUID) of the user who last modified this user record. This property is read-only.
The date on which this user record was last modified.
Note referencing the page that modified this user record.
Reserved for Docusign.
Indicates the Power Form mode setting for the user:
noneadminuser
When true, this user receives notifications when envelopes are viewed.
Information about the seals associated with this user.
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.
Contains the settings for the email notifications that senders receive about the envelopes that they send.
An array of email notifications that specifies the email the user receives when they are a recipient. 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 email notification settings when the user is created.
When true, this user gets supplemental documents when downloading documents.
When true, this user must accept supplemental documents.
When true, this user must both view and accept supplemental documents.
When true, this user must view supplemental documents.
When true, a new template is created each time the user sends an envelope.
When true, the system notifies this user before applying a matching template.
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.
Percentage used when matching templates.
When true, users see template matching functionality.
When true, daylight savings time is in effect for this user's time zone.
The custom DateTime format setting for this user.
The timezone offset for the user. Valid values:
tz_01_afghanistantz_02_alaskantz_03_arabtz_04_arabiantz_05_arabictz_06_argentinatz_07_atlantictz_08_aus_centraltz_09_aus_easterntz_10_azerbaijantz_11_azorestz_12_bangladeshtz_13_canada_centraltz_14_cape_verdetz_15_caucasustz_16_central_australiatz_17_central_americatz_18_central_asiatz_19_central_braziliantz_20_central_europetz_21_central_europeantz_22_central_pacifictz_23_centraltz_24_central_mexicotz_25_chinatz_26_datelinetz_27_east_africatz_28_east_australiatz_29_east_europetz_30_east_south_americatz_31_easterntz_32_egypttz_33_ekaterinburgtz_34_fijitz_35_flitz_36_georgiantz_37_gmttz_38_greenlandtz_39_greenwichtz_40_gtbtz_41_hawaiiantz_42_indiatz_43_irantz_44_israeltz_45_jordantz_46_kaliningradtz_47_kamchatkatz_48_koreatz_49_magadantz_50_mauritiustz_51_mid_atlantictz_52_middle_easttz_53_montevideotz_54_moroccotz_55_mountaintz_56_mountain_mexicotz_57_myanmartz_58_north_central_asiatz_59_namibiatz_60_nepaltz_61_new_zealandtz_62_new_foundlandtz_63_north_asia_easttz_64_north_asiatz_65_pacific_satz_66_pacifictz_67_pacific_mexicotz_68_pakistantz_69_paraguaytz_70_romancetz_71_russiantz_72_sa_easterntz_73_sa_pacifictz_74_sa_westerntz_75_samoatz_76_se_asiatz_77_singaporetz_78_south_africatz_79_sriLankatz_80_syriatz_81_taipeitz_82_tasmaniatz_83_tokyotz_84_tongatz_85_turkeytz_86_ulaanbaatartz_87_us_easterntz_88_us_mountaintz_89_venezuelatz_90_vladivostoktz_91_west_australiatz_92_west_central_africatz_93_west_europetz_94_west_asiatz_95_west_pacifictz_96_yakutsk
Reserved for Docusign.
Reserved for Docusign.
Reserved for Docusign.
Reserved for Docusign.
Indicates the specified Vaulting mode:
noneestoredelectronic_original
Response Body
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/users/string/settings" \ -H "Content-Type: application/json" \ -d '{}'Gets the user account settings for a specified user GET
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, see [Users:create](https://developers.docusign.com/docs/esign-rest-api/reference/users/users/create/).
Retrieves a list of signature definitions for a user GET
This method retrieves the signature definitions for the user that you specify. The `userId` parameter specified in the endpoint must match the authenticated user's user ID, and the user must be a member of the account. The `signatureId` parameter accepts a signature ID or a signature name. Docusign recommends you use signature ID (`signatureId`), since some names contain characters that do not properly encode into a URL. If you use the user name, it is likely that the name includes spaces. In that case, URL encode the name before using it in the endpoint. For example, encode "Bob Smith" as "Bob%20Smith".