docusign.users.put-user-settings

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

Updates the user account settings for a specified user.

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
userid	string	Yes	—	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.
allow_all_languages	string	No	—	—
accountagreementsaccesstype	string	No	—	—
accountagreementsaccesstypemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
accountmanagementgranular	json	No	—	Describes which account management capabilities a user has.
adminonly	string	No	—	Reserved for Docusign.
adminonlymetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowaccesstoallaccountagreements	string	No	—	—
allowaccesstoallaccountagreementsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowautotagging	string	No	—	When true, the API returns suggested tabs for documents for this user.
alloweddocumenttemplatelibraryaccess	string	No	—	—
alloweddocumenttemplatelibraryaccessmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowedorchestrationaccess	string	No	—	—
allowedorchestrationaccessmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopetransferto	string	No	—	When true, this user can participate in envelope transfers on the account.
allowenvelopetransfertometadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowesealrecipients	string	No	—	When true, this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
allowesealrecipientsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowpowerformsadmintoaccessallpowerformenvelope	string	No	—	When true and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is false.
allowpowerformsadmintoaccessallpowerformenvelopemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowrecipientlanguageselection	string	No	—	When true, this user can set the language used in the standard email format for a recipient when creating an envelope.
allowrecipientlanguageselectionmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowsendonbehalfof	string	No	—	When true, this user can send envelopes "on behalf of" other users through the API.
allowsendonbehalfofmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowsupplementaldocuments	string	No	—	When true, this user can include supplemental documents.
allowsupplementaldocumentsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowtransactions	string	No	—	—
allowtransactionsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
anchortagversionedplacementenabled	string	No	—	Reserved for Docusign.
apiaccountwideaccess	string	No	—	When true, indicates that this user can send envelope-specific API requests on the account.
apiaccountwideaccessmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
apicanexportac	string	No	—	When true, this user can export authoritative copy for the account.
apicanexportacmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
bulksend	string	No	—	When true, this user can use the bulk send feature for the account.
bulksendmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canbulkuploadagreements	string	No	—	—
canbulkuploadagreementsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canchargeaccount	string	No	—	Reserved for Docusign.
canchargeaccountmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
cancreatetransaction	string	No	—	—
cancreatetransactionmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
candeletedocumentsintransaction	string	No	—	—
candeletedocumentsintransactionmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
candeletetransaction	string	No	—	—
candeletetransactionmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
caneditsharedaddressbook	string	No	—	When true, this user can edit the shared address book for the account.
caneditsharedaddressbookmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canlockenvelopes	string	No	—	Reserved for Docusign.
canlockenvelopesmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canmanageaccount	string	No	—	When true, this user is an administrator for the account.
canmanageaccountmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canmanageagreementparties	string	No	—	—
canmanageagreementpartiesmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canmanagedistributor	string	No	—	Reserved for Docusign.
canmanagedistributormetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canmanagetemplates	string	No	—	When true, this user can manage templates for the account.
canmanagetemplatesmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
cansendapirequests	string	No	—	When true, this user can send API requests on the account.
cansendapirequestsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
cansendenvelope	string	No	—	When true, this user can send envelopes on the account.
cansendenvelopemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
cansendenvelopesviasms	string	No	—	—
cansendenvelopesviasmsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
cansignenvelope	string	No	—	When true, this user can sign envelopes.
cansignenvelopemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canusescratchpad	string	No	—	When true, this user can use a scratchpad to edit information.
canusescratchpadmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canusesmartcontracts	string	No	—	Reserved for Docusign.
canusesmartcontractsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
disabledocumentupload	string	No	—	When true, this user is prohibited from uploading documents during sending.
disabledocumentuploadmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
disableotheractions	string	No	—	When true, this user can access the Other Actions menu.
disableotheractionsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enabledspro	string	No	—	Reserved for Docusign.
enabledsprometadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablekeytermssuggestionsbydocumenttype	string	No	—	—
enablekeytermssuggestionsbydocumenttypemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablesequentialsigningapi	string	No	—	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.
enablesequentialsigningapimetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablesequentialsigningui	string	No	—	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.
enablesequentialsigninguimetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignerattachments	string	No	—	When true, this user can use the signing attachments feature.
enablesignerattachmentsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignonpaperoverride	string	No	—	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.
enablesignonpaperoverridemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enabletransactionpoint	string	No	—	Reserved for Docusign.
enabletransactionpointmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablevaulting	string	No	—	When true, Vaulting is enabled for the account.
enablevaultingmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
expresssendonly	string	No	—	When false, this user can apply tabs to documents during the sending experience.
ismanagedbyscim	string	No	—	—
ismanagedbyscimmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
ismembershipmanagedbyscim	string	No	—	—
ismembershipmanagedbyscimmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
locale	string	No	—	The user's locale code. Valid values are: - zh_CN - zh_TW - nl - en - fr - de - it - ja - ko - pt - pt_BR - ru - es
localemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
localepolicy	json	No	—	—
manageclickwrapsmode	string	No	—	When true, this user can create and manage Clickwraps.
manageclickwrapsmodemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
modifiedby	string	No	—	The user ID (GUID) of the user who last modified this user record. This property is read-only.
modifiedbymetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
modifieddate	string	No	—	The date on which this user record was last modified.
modifieddatemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
modifiedpage	string	No	—	Note referencing the page that modified this user record.
modifiedpagemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
newsendui	string	No	—	Reserved for Docusign.
newsenduimetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
powerformmode	string	No	—	Indicates the Power Form mode setting for the user: - none - admin - user
powerformmodemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
recipientviewednotification	string	No	—	When true, this user receives notifications when envelopes are viewed.
recipientviewednotificationmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
sealidentifiers	list	No	—	Information about the seals associated with this user.
selfsignedrecipientemaildocument	string	No	—	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.
selfsignedrecipientemaildocumentmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
senderemailnotifications	json	No	—	Contains the settings for the email notifications that senders receive about the envelopes that they send.
signeremailnotifications	json	No	—	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.
supplementaldocumentincludeindownload	string	No	—	When true, this user gets supplemental documents when downloading documents.
supplementaldocumentsmustaccept	string	No	—	When true, this user must accept supplemental documents.
supplementaldocumentsmustacceptmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
supplementaldocumentsmustread	string	No	—	When true, this user must both view and accept supplemental documents.
supplementaldocumentsmustreadmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
supplementaldocumentsmustview	string	No	—	When true, this user must view supplemental documents.
supplementaldocumentsmustviewmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
templateactivecreation	string	No	—	When true, a new template is created each time the user sends an envelope.
templateactivecreationmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
templateapplynotify	string	No	—	When true, the system notifies this user before applying a matching template.
templateapplynotifymetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
templateautomatching	string	No	—	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.
templateautomatchingmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
templatematchingsensitivity	string	No	—	Percentage used when matching templates.
templatematchingsensitivitymetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
templatepagelevelmatching	string	No	—	When true, users see template matching functionality.
templatepagelevelmatchingmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
timezonedst	string	No	—	When true, daylight savings time is in effect for this user's time zone.
timezonedstmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
timezonemask	string	No	—	The custom DateTime format setting for this user.
timezonemaskmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
timezoneoffset	string	No	—	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
timezoneoffsetmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
timezonesendingpref	string	No	—	Reserved for Docusign.
timezonesendingprefmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
timezonesigningpref	string	No	—	Reserved for Docusign.
timezonesigningprefmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
transactionpointsitenameurl	string	No	—	Reserved for Docusign.
transactionpointsitenameurlmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
transactionpointusername	string	No	—	Reserved for Docusign.
transactionpointusernamemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
vaultingmode	string	No	—	Indicates the specified Vaulting mode: - none - estored - electronic_original
vaultingmodemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
webforms	string	No	—	—
webformsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
userid	string	Yes	—	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.
allow_all_languages	string	No	—	—
accountagreementsaccesstype	string	No	—	—
accountagreementsaccesstypemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
accountmanagementgranular	json	No	—	Describes which account management capabilities a user has.
adminonly	string	No	—	Reserved for Docusign.
adminonlymetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowaccesstoallaccountagreements	string	No	—	—
allowaccesstoallaccountagreementsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowautotagging	string	No	—	When true, the API returns suggested tabs for documents for this user.
alloweddocumenttemplatelibraryaccess	string	No	—	—
alloweddocumenttemplatelibraryaccessmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowedorchestrationaccess	string	No	—	—
allowedorchestrationaccessmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopetransferto	string	No	—	When true, this user can participate in envelope transfers on the account.
allowenvelopetransfertometadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowesealrecipients	string	No	—	When true, this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient
allowesealrecipientsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowpowerformsadmintoaccessallpowerformenvelope	string	No	—	When true and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is false.
allowpowerformsadmintoaccessallpowerformenvelopemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowrecipientlanguageselection	string	No	—	When true, this user can set the language used in the standard email format for a recipient when creating an envelope.
allowrecipientlanguageselectionmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowsendonbehalfof	string	No	—	When true, this user can send envelopes "on behalf of" other users through the API.
allowsendonbehalfofmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowsupplementaldocuments	string	No	—	When true, this user can include supplemental documents.
allowsupplementaldocumentsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
allowtransactions	string	No	—	—
allowtransactionsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
anchortagversionedplacementenabled	string	No	—	Reserved for Docusign.
apiaccountwideaccess	string	No	—	When true, indicates that this user can send envelope-specific API requests on the account.
apiaccountwideaccessmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
apicanexportac	string	No	—	When true, this user can export authoritative copy for the account.
apicanexportacmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
bulksend	string	No	—	When true, this user can use the bulk send feature for the account.
bulksendmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canbulkuploadagreements	string	No	—	—
canbulkuploadagreementsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canchargeaccount	string	No	—	Reserved for Docusign.
canchargeaccountmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
cancreatetransaction	string	No	—	—
cancreatetransactionmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
candeletedocumentsintransaction	string	No	—	—
candeletedocumentsintransactionmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
candeletetransaction	string	No	—	—
candeletetransactionmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
caneditsharedaddressbook	string	No	—	When true, this user can edit the shared address book for the account.
caneditsharedaddressbookmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canlockenvelopes	string	No	—	Reserved for Docusign.
canlockenvelopesmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canmanageaccount	string	No	—	When true, this user is an administrator for the account.
canmanageaccountmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canmanageagreementparties	string	No	—	—
canmanageagreementpartiesmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canmanagedistributor	string	No	—	Reserved for Docusign.
canmanagedistributormetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canmanagetemplates	string	No	—	When true, this user can manage templates for the account.
canmanagetemplatesmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
cansendapirequests	string	No	—	When true, this user can send API requests on the account.
cansendapirequestsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
cansendenvelope	string	No	—	When true, this user can send envelopes on the account.
cansendenvelopemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
cansendenvelopesviasms	string	No	—	—
cansendenvelopesviasmsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
cansignenvelope	string	No	—	When true, this user can sign envelopes.
cansignenvelopemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canusescratchpad	string	No	—	When true, this user can use a scratchpad to edit information.
canusescratchpadmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
canusesmartcontracts	string	No	—	Reserved for Docusign.
canusesmartcontractsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
disabledocumentupload	string	No	—	When true, this user is prohibited from uploading documents during sending.
disabledocumentuploadmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
disableotheractions	string	No	—	When true, this user can access the Other Actions menu.
disableotheractionsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enabledspro	string	No	—	Reserved for Docusign.
enabledsprometadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablekeytermssuggestionsbydocumenttype	string	No	—	—
enablekeytermssuggestionsbydocumenttypemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablesequentialsigningapi	string	No	—	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.
enablesequentialsigningapimetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablesequentialsigningui	string	No	—	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.
enablesequentialsigninguimetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignerattachments	string	No	—	When true, this user can use the signing attachments feature.
enablesignerattachmentsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignonpaperoverride	string	No	—	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.
enablesignonpaperoverridemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enabletransactionpoint	string	No	—	Reserved for Docusign.
enabletransactionpointmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
enablevaulting	string	No	—	When true, Vaulting is enabled for the account.
enablevaultingmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
expresssendonly	string	No	—	When false, this user can apply tabs to documents during the sending experience.
ismanagedbyscim	string	No	—	—
ismanagedbyscimmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
ismembershipmanagedbyscim	string	No	—	—
ismembershipmanagedbyscimmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
locale	string	No	—	The user's locale code. Valid values are: - zh_CN - zh_TW - nl - en - fr - de - it - ja - ko - pt - pt_BR - ru - es
localemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
localepolicy	json	No	—	—
manageclickwrapsmode	string	No	—	When true, this user can create and manage Clickwraps.
manageclickwrapsmodemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
modifiedby	string	No	—	The user ID (GUID) of the user who last modified this user record. This property is read-only.
modifiedbymetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
modifieddate	string	No	—	The date on which this user record was last modified.
modifieddatemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
modifiedpage	string	No	—	Note referencing the page that modified this user record.
modifiedpagemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
newsendui	string	No	—	Reserved for Docusign.
newsenduimetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
powerformmode	string	No	—	Indicates the Power Form mode setting for the user: - none - admin - user
powerformmodemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
recipientviewednotification	string	No	—	When true, this user receives notifications when envelopes are viewed.
recipientviewednotificationmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
sealidentifiers	list	No	—	Information about the seals associated with this user.
selfsignedrecipientemaildocument	string	No	—	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.
selfsignedrecipientemaildocumentmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
senderemailnotifications	json	No	—	Contains the settings for the email notifications that senders receive about the envelopes that they send.
signeremailnotifications	json	No	—	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.
supplementaldocumentincludeindownload	string	No	—	When true, this user gets supplemental documents when downloading documents.
supplementaldocumentsmustaccept	string	No	—	When true, this user must accept supplemental documents.
supplementaldocumentsmustacceptmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
supplementaldocumentsmustread	string	No	—	When true, this user must both view and accept supplemental documents.
supplementaldocumentsmustreadmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
supplementaldocumentsmustview	string	No	—	When true, this user must view supplemental documents.
supplementaldocumentsmustviewmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
templateactivecreation	string	No	—	When true, a new template is created each time the user sends an envelope.
templateactivecreationmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
templateapplynotify	string	No	—	When true, the system notifies this user before applying a matching template.
templateapplynotifymetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
templateautomatching	string	No	—	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.
templateautomatchingmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
templatematchingsensitivity	string	No	—	Percentage used when matching templates.
templatematchingsensitivitymetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
templatepagelevelmatching	string	No	—	When true, users see template matching functionality.
templatepagelevelmatchingmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
timezonedst	string	No	—	When true, daylight savings time is in effect for this user's time zone.
timezonedstmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
timezonemask	string	No	—	The custom DateTime format setting for this user.
timezonemaskmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
timezoneoffset	string	No	—	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
timezoneoffsetmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
timezonesendingpref	string	No	—	Reserved for Docusign.
timezonesendingprefmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
timezonesigningpref	string	No	—	Reserved for Docusign.
timezonesigningprefmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
transactionpointsitenameurl	string	No	—	Reserved for Docusign.
transactionpointsitenameurlmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
transactionpointusername	string	No	—	Reserved for Docusign.
transactionpointusernamemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
vaultingmode	string	No	—	Indicates the specified Vaulting mode: - none - estored - electronic_original
vaultingmodemetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
webforms	string	No	—	—
webformsmetadata	json	No	—	Metadata that indicates whether a property is editable and describes setting-specific options.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call PUT /v2.1/accounts/{accountId}/users/{userId}/settings
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform PUT /v2.1/accounts/{accountId}/users/{userId}/settings
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.users.put-user-settings",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "userid": "value"
  }
}