Skip to content
Proud to collaborate with Microsoft for Startups

docusign.accounts.put-settings ​

Updates the account settings for the specified account. Although the request body for this method is a complete accountSettingsInformation object, you only need to provide the properties that you are updating.

Updates the account settings for an account.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-docusign
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
base_urlstringYes—Docusign API root, e.g. https://<host>/api
api_tokenstringNo—Bearer token; omit to use the workflow's token env var
accountidstringYes—The external account number (int) or account ID GUID.
accesscodeformatjsonNo—Object specifying the format of the string provided to a recipient in order to access an envelope.
accountdatetimeformatstringNo—UTC date/time format for the account.
accountdatetimeformatmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
accountdefaultlanguagestringNo——
accountdefaultlanguagemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
accountnamestringNo—The name on the account.
accountnamemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
accountnotificationjsonNo—A complex element that specifies notifications (expirations and reminders) for the envelope.
accountuisettingsjsonNo—An object that defines the options that are available to non-administrators in the UI.
additionalsettingslistNo——
adoptsigconfigstringNo—When true, Signature Adoption Configuration is enabled. Note: Only Admin users can change this setting.
adoptsigconfigmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
advancedcorrectstringNo—When true, the Advanced Correction feature is enabled for this account.
advancedcorrectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
advancedsearchenabletabfieldstringNo——
advancedsearchenabletabfieldmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
advancedsearchenabletemplateidfieldstringNo——
advancedsearchenabletemplateidfieldmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
advancedsearchenabletemplatenamefieldstringNo——
advancedsearchenabletemplatenamefieldmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
aiassistedwebformcreationlevelstringNo——
aiassistedwebformcreationlevelmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowaccesscodeformatstringNo—When true, the configured Access Code Format page is enabled for account administrators. Note: Only Admin users can change this setting.
allowaccesscodeformatmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowaccountmanagementgranularstringNo—When true, the account can be managed on a per-user basis. Note: Only Admin users can change this setting.
allowaccountmanagementgranularmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowaccountmembernamechangestringNo—Boolean that specifies whether member names can be changed in the account.
allowaccountmembernamechangemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowacestringNo——
allowacemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowadvancedrecipientroutingconditionalstringNo—When true, Conditional Routing is enabled for the account as part of Docusign's Advanced Recipient Routing feature.
allowadvancedrecipientroutingconditionalmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowagentnameemaileditstringNo—When true, an agent recipient can change the email addresses of recipients later in the signing order.
allowagentnameemaileditmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowagreementactionsstringNo——
allowagreementactionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowagreementorchestrationsstringNo——
allowagreementorchestrationsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowautonavsettingsstringNo—When true, auto-navigation can be enabled for this account.
allowautonavsettingsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowautotaggingstringNo—When true, auto-tagging is enabled for the account.
allowautotaggingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowbulksendstringNo—When true, bulk send functionality is enabled for the account. Note: Only Admin users can change this setting.
allowbulksendmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowbyoidvstringNo——
allowbyoidvmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowcdwithdrawstringNo—When true, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is false. Note: Only Admin users can change this setting.
allowcdwithdrawmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowconnectagreementuistringNo——
allowconnectagreementuimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowconnectauthoritativecopyreadyeventuistringNo——
allowconnectenveloperemindersenteventuistringNo——
allowconnectenveloperemovedeventstringNo——
allowconnectextensionuistringNo——
allowconnecthttplistenerconfigsstringNo—Boolean that specifies whether a Connect configuration can use HTTP listeners.
allowconnectidentityverificationuistringNo——
allowconnectoauthuistringNo——
allowconnectsendfinishlaterstringNo—Reserved for Docusign.
allowconnectsendfinishlatermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowconnectunifiedpayloaduistringNo——
allowconnectworkspaceuploadrequestuistringNo——
allowconsumerdisclosureoverridestringNo—When true, the account has the ability to change the Consumer Disclosure setting.
allowconsumerdisclosureoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdatadownloadstringNo—When true, senders can download form data from the envelopes that they send. Note: Only Admin users can change this setting.
allowdatadownloadmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdelayedroutingstringNo—"true" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, "false" otherwise.
allowdelayedroutingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdelegatedsigningstringNo——
allowdelegatedsigningmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdocgendocumentsstringNo——
allowdocgendocumentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdocumentdisclosuresstringNo—Boolean that specifies whether disclosure documents can be included in envelopes.
allowdocumentdisclosuresmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdocumentsonsignedenvelopesstringNo—Boolean that specifies whether notifications can include the envelope's signed document.
allowdocumentsonsignedenvelopesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdocumentvisibilitystringNo—When true, the Document Visibility feature is enabled for the account.
allowdocumentvisibilitymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloweditingenvelopesonbehalfofothersstringNo——
alloweditingenvelopesonbehalfofothersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowehankostampsstringNo—When true, eHanko stamps are enabled.
allowehankostampsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenoteeoriginalstringNo—Specifies whether eNote eOriginal integration is enabled.
allowenoteeoriginalmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopecorrectstringNo—When true, the envelope correction feature is enabled. Note: Only Admin users can change this setting.
allowenvelopecorrectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopecustodytransferstringNo—Specifies whether the account is able to manage rules that transfer ownership of envelopes within the same account.
allowenvelopecustodytransfermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopecustomfieldsstringNo—Specifies whether envelope custom fields are enabled.
allowenvelopecustomfieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopepublishreportingstringNo—When true, envelope publishing reporting is enabled. Note: Only Admin users can change this setting.
allowenvelopepublishreportingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopereportingstringNo—Specifies whether the account has access to reports.
allowenvelopereportingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowexpressionstringNo—If the account plan does not include calculated fields, this setting allows an account to use them.
allowexpressionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowexpresssignercertificatestringNo—When true, signers are required to use Express Digital Signatures. Note: Only Admin users can change this setting.
allowexpresssignercertificatemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowextendedsendingresourcefilestringNo—Boolean that specifies whether resource files can be used for extended sending.
allowextendedsendingresourcefilemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowexternallinkedaccountsstringNo——
allowexternallinkedaccountsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowexternalsignaturepadstringNo—When true, the account can configure and use signature pads for their recipients. Note: Only Admin users can change this setting.
allowexternalsignaturepadmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowfedrampidvlevel1stringNo——
allowfedrampidvlevel1metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowfedrampidvlevel2stringNo——
allowfedrampidvlevel2metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvforeuqualifiedsignaturesstringNo——
allowidvforeuqualifiedsignaturesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvlevel1stringNo—When true, IDV Level 1 is allowed. The default value is false.
allowidvlevel1metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvlevel1trialstringNo——
allowidvlevel1trialmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvlevel2stringNo——
allowidvlevel2metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvlevel3stringNo——
allowidvlevel3metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvplatformstringNo——
allowidvplatformmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvriskassessmentstringNo——
allowidvriskassessmentmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowinpersonstringNo—When true, the account administrator can enable in-person signing. Note: Only SysAdmin users can change this setting.
allowinpersonelectronicnotarystringNo—Account-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.
allowinpersonelectronicnotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowinpersonmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmanagedstampsstringNo—When true, Managed Stamps are enabled.
allowmanagedstampsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmanagingenvelopesonbehalfofothersstringNo——
allowmanagingenvelopesonbehalfofothersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmarkupstringNo—When true, the Document Markup feature is enabled. Note: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.
allowmarkupmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmembertimezonestringNo—When true, account users can set their own time zone settings. Note: Only Admin users can change this setting.
allowmembertimezonemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmergefieldsstringNo—When true, the account can use merge fields with Docusign for Salesforce.
allowmergefieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmultiplebrandprofilesstringNo—Specifies whether the account supports multiple brands.
allowmultiplebrandprofilesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmultiplesignerattachmentsstringNo—When true, recipients can upload multiple signer attachments with a single attachment. Note: Only Admin users can change this setting.
allowmultiplesignerattachmentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allownonusphoneauthstringNo—Specifies whether users can use international numbers for phone authentication.
allownonusphoneauthmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowocrofenvelopedocumentsstringNo——
allowocrofenvelopedocumentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowofflinesigningstringNo—When true, offline signing is enabled for the account. Note: Only Admin users can change this setting.
allowofflinesigningmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowonlystandalonewebformsstringNo——
allowonlystandalonewebformsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowopentrustsignercertificatestringNo—When true, senders can use OpenTrust signer certificates. Note: Only Admin users can change this setting.
allowopentrustsignercertificatemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationbrandingstringNo——
alloworganizationbrandingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationdocusignmonitorstringNo——
alloworganizationdocusignmonitorfreestringNo——
alloworganizationdocusignmonitorfreemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationdocusignmonitormetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationdomainusermanagementstringNo——
alloworganizationdomainusermanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationsstringNo—Boolean that specifies whether Docusign Admin is enabled for the account.
alloworganizationsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationssomanagementstringNo——
alloworganizationssomanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationtouseinpersonelectronicnotarystringNo—Organization-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.
alloworganizationtouseinpersonelectronicnotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationtouseremotenotarystringNo——
alloworganizationtouseremotenotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationtousethirdpartyelectronicnotarystringNo—Org level flag that determines the availability to perform Third Party Notary (3PN) actions.
alloworganizationtousethirdpartyelectronicnotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowparticipantrecipienttypestringNo——
allowparticipantrecipienttypemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowpaymentprocessingstringNo—When true, payment processing is enabled for the account. Note: Only Admin users can change this setting.
allowpaymentprocessingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowpendingdestinationurleditionstringNo——
allowpendingdestinationurleditionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowperformanceanalyticsstringNo——
allowperformanceanalyticsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowphoneauthenticationstringNo—Boolean that specifies whether phone authentication is enabled for the account.
allowphoneauthenticationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowphoneauthoverridestringNo—Boolean that specifies whether users can override phone authentication.
allowphoneauthoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowprivatesigninggroupsstringNo—Reserved for Docusign. This property returns the value false when listing account settings. This property is read-only.
allowprivatesigninggroupsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowrecipientconnectstringNo——
allowrecipientconnectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowremindersstringNo—When true, an account administrator can to turn on reminders and expiration defaults for the account. Note: Only Admin users can change this setting.
allowremindersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowremotenotarystringNo——
allowremotenotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowresourcefilebrandingstringNo—When true, resource files can be uploaded in branding.
allowresourcefilebrandingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsafebiopharmasignercertificatestringNo—When true, account administrators can specify that signers are required to use SAFE-BioPharma digital signatures. Note: Only Admin users can change this setting.
allowsafebiopharmasignercertificatemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowscheduledsendingstringNo—"true" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, "false" otherwise.
allowscheduledsendingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsecurityappliancestringNo—Boolean that specifies whether a Docusign Signature Appliance can be used with the account.
allowsecurityappliancemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsendingenvelopesonbehalfofothersstringNo——
allowsendingenvelopesonbehalfofothersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsendtocertifieddeliverystringNo—When true, the account admin can enable the Send to Certified Delivery feature on the account.
allowsendtocertifieddeliverymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsendtointermediarystringNo—When true, the account admin can enable the Send to Intermediary feature on the account.
allowsendtointermediarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowservertemplatesstringNo—When true, the account can use templates.
allowservertemplatesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsetembeddedrecipientstarturlstringNo——
allowsetembeddedrecipientstarturlmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsharedtabsstringNo—When true, shared tabs are enabled for the account. Note: Only Admin users can change this setting.
allowsharedtabsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsignaturestampsstringNo—When true, Signature Stamps are enabled. Note: Only Admin users can change this setting.
allowsignaturestampsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsigndocumentfromhomepagestringNo—When true, recipients can sign documents from the home page. Note: Only Admin users can change this setting.
allowsigndocumentfromhomepagemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsignerreassignstringNo—When true, the recipient of an envelope sent from this account can reassign it to another person. Note: Only Admin users can change this setting.
allowsignerreassignmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsignerreassignoverridestringNo—When true, an account administrator can override the ability of an envelope recipient to reassign it to another person. Note: Only Admin users can change this setting.
allowsignerreassignoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsigningextensionsstringNo—Boolean that specifies whether Signing and App Extensions are allowed.
allowsigningextensionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsigninggroupsstringNo—When true, the account allows signing groups. This setting is only shown in responses that list account settings. This property is read-only.
allowsigninggroupsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsigninginsightsstringNo——
allowsigninginsightsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsigningradiodeselectstringNo—Boolean that specifies whether the account supports radio buttons on tabs Radio CustomTabType.
allowsigningradiodeselectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsignnowstringNo—When true, the account administrator can enable the Sign Now feature.
allowsignnowmetadatastringNo—Metadata that indicates whether the allowSignNow property is editable.
allowsmsdeliverystringNo——
allowsmsdeliverymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsocialidloginstringNo—Deprecated.
allowsocialidloginmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsupplementaldocumentsstringNo—When true, this user can include supplemental documents.
allowsupplementaldocumentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowthirdpartyelectronicnotarystringNo—Account level flag that determines the availability to perform Third Party Notary (3PN) actions.
allowthirdpartyelectronicnotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowtransactionsworkspacestringNo——
allowtransactionsworkspacemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowtransactionsworkspaceoriginalstringNo——
allowtransactionsworkspaceoriginalmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowuserstoaccessdirectorystringNo——
allowuserstoaccessdirectorymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowvalueinsightsstringNo——
allowvalueinsightsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowwebformsstringNo——
allowwebformsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowwhatsappdeliverystringNo——
allowwhatsappdeliverymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
anchorpopulationscopestringNo—This property determines how template anchor tabs are applied. Valid values are: - document: Anchor tabs are applied only to the document that you specify. - envelope: Anchor tabs are applied to all of the documents in the envelope associated with the template. Note: When you are using the anchorPopulationScope property with a Composite Template, the value document is supported only with a single server template and a single inline template.
anchorpopulationscopemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
anchortagversionedplacementenabledstringNo—Reserved for Docusign.
anchortagversionedplacementmetadataenabledjsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
attachcompletedenvelopestringNo—When true, envelope documents are included as a PDF file attachment to "signing completed" emails. Note: Only SysAdmin users can change this setting.
attachcompletedenvelopemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
authenticationcheckstringNo—Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: - Phone Authentication - SMS Authentication - Knowledge-Based ID This setting takes one of the following options: - initial_access: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account. - each_access: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable time frame. Note: Only Admin users can change this setting.
authenticationcheckmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
autonavrulestringNo—Specifies how auto-navigation works. Valid values are: - off - required_fields - required_and_blank_fields - all_fields - page_then_required_fields - page_then_required_and_blank_fields - page_then_all_fields
autonavrulemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
autoprovisionsigneraccountstringNo—Boolean that specifies whether to automatically provision a user membership in the account for accountless recipients. (Also known as Just-in-Time provisioning.)
autoprovisionsigneraccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
bccemailarchivestringNo—Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address.
bccemailarchivemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
betaswitchconfigurationstringNo—Reserved for Docusign.
betaswitchconfigurationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
billingaddressjsonNo—Contains address information.
billingaddressmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
bulksendstringNo—When true, this user can use the bulk send feature for the account.
bulksendactionresendlimitstringNo——
bulksendmaxcopiesinbatchstringNo——
bulksendmaxunprocessedenvelopescountstringNo——
bulksendmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
canselfbrandsendstringNo—When true, account administrators can self-brand their sending console through the Docusign console.
canselfbrandsendmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
canselfbrandsignstringNo—When true, account administrators can self-brand their signing console through the Docusign console.
canselfbrandsignmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
canusesalesforceoauthstringNo——
canusesalesforceoauthmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
capturevoicerecordingstringNo—Reserved for Docusign.
capturevoicerecordingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
cfr21simplifiedsigningenabledstringNo——
cfr21simplifiedsigningenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
cfrusewideimagestringNo—Boolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image.
cfrusewideimagemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
checkformultipleadminsonaccountstringNo——
checkformultipleadminsonaccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
chromesignatureenabledstringNo—Boolean that specifies whether the signers of the envelopes from this account use a signature with a Docusign chrome around it or not.
chromesignatureenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
cloudreadystringNo——
commentemailshowmessagetextstringNo—When true, the text of comments is included in email notifications when a comment is posted. Note: If the envelope requires additional recipient authentication, comment text is not included.
commentemailshowmessagetextmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
commentsallowenvelopeoverridestringNo—When true and comments are enabled for the account, senders can disable comments for an envelope through the Advanced Options menu that appears during the sending process.
commentsallowenvelopeoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
conditionalfieldsenabledstringNo—When true, conditional fields can be used in documents. Note: Only Admin users can change this setting.
conditionalfieldsenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
consumerdisclosurefrequencystringNo—Speficies how often to display the consumer disclosure. Valid values are: - once: Per account, the supplemental document is displayed once only per userId. - always: Per envelope, the supplemental document is displayed once only per userId. - each_access: Per envelope, the supplemental document is displayed once only per recipientId.
consumerdisclosurefrequencymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
convertpdffieldsstringNo—Boolean that specifies whether to enable PDF form fields to get converted to Docusign secure fields when the document is added or uploaded to an envelope.
convertpdffieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
customextractionplanlevelsstringNo——
customextractionplanlevelsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
datapopulationscopestringNo—Specifies how data is shared for tabs with the same tabLabel. Valid values are: - document: Tabs in a document with the same label populate with the same data. - envelope: Tabs in all documents in the envelope with the same label populate with the same data. - notset: Use the global account setting. This setting applies to the following tab types: - Check box - Company - Data field - Drop-down list - Full name - Formula - Note - Title Note: Only Admin users can change this setting. Changing this setting affects envelopes that have been sent but not completed.
datapopulationscopemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
defaultsigningresponsiveviewstringNo——
defaultsigningresponsiveviewmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
defaultsigningresponsiveviewusegradestringNo——
defaultsigningresponsiveviewusegrademetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
defaulttoadvancedenvelopesfilterformstringNo——
defaulttoadvancedenvelopesfilterformmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disableautotemplatematchingstringNo——
disableautotemplatematchingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablelegacykbastringNo——
disablelegacykbametadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablelegacysharedenvelopesstringNo——
disablelegacysharedenvelopesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablemobileappstringNo—When true, the mobile app distributor key is prevented from connecting for account users.
disablemobileappmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablemobilepushnotificationsstringNo—When true, push notifications are disabled for the account. Note: Only Admin users can change this setting.
disablemobilepushnotificationsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablemobilesendingstringNo—When true, sending from a mobile application is disabled. Note: Only Admin users can change this setting.
disablemobilesendingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablemultiplesessionsstringNo—When true, account users cannot be logged into multiple sessions at the same time. Note: Only Admin users can change this setting.
disablemultiplesessionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablepurgenotificationsforsendermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablesignercertviewstringNo—When true, signers cannot view certificates of completion.
disablesignercertviewmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablesignerhistoryviewstringNo—When true, signers cannot view envelope history.
disablesignerhistoryviewmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablestylesignaturestringNo—When true, the Select Style option is hidden from signers and they must draw their signature instead.
disablestylesignaturemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disableuploadsignaturestringNo—When true, signers cannot upload custom image files of their signature and initials. Note: Only Admin users can change this setting.
disableuploadsignaturemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disableusersharingstringNo—When true, the User Sharing feature is disabled for the account.
disableusersharingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
displaybetaswitchstringNo—Boolean that specifies whether to display a Beta switch for your app.
displaybetaswitchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
documentconversionrestrictionsstringNo—Sets the account document upload restriction for non-account administrators. Valid values are: - no_restrictions: There are no restrictions on the type of documents that can be uploaded. - allow_pdf_only: Non-administrators can only upload PDF files. - no_upload: Non-administrators cannot upload files. Note: Only Admin users can change this setting.
documentconversionrestrictionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
documentretentionstringNo—Sets a document retention period, which controls the number of days that Docusign retains documents after they have reached a completed,declined, or voided state. When document retention is enabled for the account, the default value is 356 days.
documentretentionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
documentretentionpurgetabsstringNo—When true and documentRetention is set, document fields and metadata are also purged after the document retention period ends. The default value is false. Note: Only Admins can change this setting.
documentvisibilitystringNo—Configures the Document Visibility feature for the account. Valid values are: - Off: Document Visibility is not active for the account. - MustSignToViewUnlessSenderAccount: Document Visibility is enabled for all envelopes sent from the account. Any member of the sending account can view all of the documents in an envelope. - MustSignToViewUnlessSender: Document Visibility is enabled for all envelopes sent from the account. Only the sender can view all of the documents in an envelope. - SenderCanSetMustSignToViewUnlessSenderAccount: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents within it are still visible to any member of the sending account. Vd- SenderCanSetMustSignToViewUnlessSender: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents in the envelope are visible only to the sender. Note: For this configuration to take effect, allowDocumentVisibility must be set to true.
documentvisibilitymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
draftenveloperetentionstringNo——
draftenveloperetentionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
dss_sign_28411_enableleavepageprompt_radminoptionstringNo——
dss_sign_29182_slideupbar_radminoptionstringNo——
emailtemplateversionstringNo—Specifies the version of the email templates used in an account. If new signing is selected in a member's Admin page, the user is updated to the newest version (1.1), the minimum version of email supported for the account.
emailtemplateversionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaccesscodegeneratorstringNo—When true, enables Access Code Generator on the account.
enableaccesscodegeneratormetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaccountwidesearchstringNo——
enableaccountwidesearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadditionaladvancedwebformsfeaturesstringNo——
enableadditionaladvancedwebformsfeaturesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadmhealthcarestringNo—Account Level Flag that determines the availability to use ADM Healthcare fields
enableadmhealthcaremetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadvancedenvelopessearchstringNo——
enableadvancedenvelopessearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadvancedpaymentsstringNo—When true, enables Advanced Payments for the account.
enableadvancedpaymentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadvancedpowerformsstringNo—When true, enables advanced PowerForms for the account.
enableadvancedpowerformsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadvancedsearchstringNo——
enableadvancedsearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableagreementactionsforclmstringNo——
enableagreementactionsforclmmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableagreementactionsforesignstringNo——
enableagreementactionsforesignmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableagreementdeskadvancedstringNo——
enableagreementdeskadvancedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaiagentsstringNo——
enableaiagentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaicontractreviewstringNo——
enableaicontractreviewmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaisendermessagestringNo——
enableaisendermessagemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaisuggestedfieldsstringNo——
enableaisuggestedfieldsautoplacestringNo——
enableaisuggestedfieldsautoplacemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaisuggestedfieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableautonavstringNo—When true, enables the account to set the AutoNav rule setting, which enables a sender to override the auto-navigation setting per envelope. Note: To change this setting, you must be a SysAdmin user or `EnableAutoNavByDSAdmin must be set.
enableautonavmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablebatchupdateenvelopetypesstringNo——
enablebatchupdateenvelopetypesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablebccdummylinkstringNo——
enablebccdummylinkmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecacpivsignaturegroupstringNo——
enablecacpivsignaturegroupmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecalculatedfieldsstringNo—When true, calculated fields are enabled for the account. Note: This setting can be changed only by Admin users, and only if the account-level setting allowExpression is set to true.
enablecalculatedfieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecfrrapidsigningembeddedauthstringNo——
enablecfrrapidsigningembeddedauthmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickplusstringNo——
enableclickplusconditionalcontentstringNo——
enableclickplusconditionalcontentmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickpluscustomfieldsstringNo——
enableclickpluscustomfieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickpluscustomstylestringNo——
enableclickpluscustomstylemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickplusdynamiccontentstringNo——
enableclickplusdynamiccontentmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickplusmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickwrapsstringNo—Boolean that specifies whether clickwraps are enabled in your app. A clickwrap is an iframe that you embed in your own website or app.
enableclickwrapsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecombinedpdfdownloadforsbsstringNo——
enablecommentshistorydownloadinsigningstringNo——
enablecommentshistorydownloadinsigningmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecontactsuggestionsstringNo——
enablecontactsuggestionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecontentsearchstringNo——
enablecontentsearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecoupacoreextensionstringNo——
enablecoupacoreextensionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecoupaiamconnectorstringNo——
enablecoupaiamconnectormetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecustomdataverificationextensionsstringNo——
enablecustomdataverificationextensionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecustomersatisfactionmetrictrackingstringNo—When true, enables customer satisfaction metric tracking for the account.
enablecustomersatisfactionmetrictrackingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledataverificationextensionsstringNo——
enabledataverificationextensionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledocumenttemplatelibrarystringNo——
enabledocumenttemplatelibrarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigeuadvancedpensstringNo——
enabledsigeuadvancedpensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigexpresspensstringNo——
enabledsigexpresspensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigidcheckforaespensstringNo——
enabledsigidcheckforaespensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigidcheckinpersonforqespensstringNo——
enabledsigidcheckinpersonforqespensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigidcheckremoteforqespensstringNo——
enabledsigidcheckremoteforqespensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigidverificationpensstringNo——
enabledsigidverificationpensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigidverificationpremierpensstringNo——
enabledsigidverificationpremierpensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigpengroupeuqesstringNo——
enabledsigpengroupeuqesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigplgeuqespensstringNo——
enabledsigplgeuqespensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsprostringNo—Reserved for Docusign.
enabledsprometadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableenforcetlsemailssettingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableenvelopestampingbyaccountadminstringNo—When true, enables the account administrator to control envelope stamping for an account (stamping the envelopeId in the document margins). Note: This setting can be changed only by Admin users, and only if the account-level setting enableEnvelopeStampingByDSAdmin is set to true.
enableenvelopestampingbyaccountadminmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableenvelopestampingbydsadminstringNo—When true, enables the Docusign administrator to control envelope stamping for an account (placement of the envelopeId).
enableenvelopestampingbydsadminmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableesignapihourlylimitmanagementstringNo——
enableesignapihourlylimitmanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableesigncommunitiesstringNo——
enableesigncommunitiesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableesigntaskliststringNo——
enableesigntasklistmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablegenerationwith3pintegrationstringNo——
enablegenerationwith3pintegrationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablegreenhouseappstringNo——
enablegreenhouseappmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablei9ondemandstringNo——
enablei9ondemandmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableiamclauselibrarystringNo——
enableiamclauselibrarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableiamforxembeddeduxstringNo——
enableiamforxembeddeduxmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableidfxaccountlesssmsauthforpart11stringNo——
enableidfxaccountlesssmsauthforpart11metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableidfxintuitkbastringNo——
enableidfxintuitkbametadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableidfxphoneauthenticationstringNo——
enableidfxphoneauthenticationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableidfxphoneauthsignatureauthstatusstringNo——
enableidfxphoneauthsignatureauthstatusmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableinboxbrowseviewspoweredbyelasticsearchstringNo——
enableinboxbrowseviewspoweredbyelasticsearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableinboxrelevancesortstringNo——
enableinboxrelevancesortmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableinbrowsereditorstringNo——
enableinbrowsereditormetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablekeytermssuggestionsbydocumenttypestringNo——
enablekeytermssuggestionsbydocumenttypemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablelargefilesupportstringNo——
enablelargefilesupportmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablelegacysharedenvelopesstringNo——
enablelegacysharedenvelopesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablelicensemanagementstringNo——
enablelicensemanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablemicrosoftdynamics365extensionstringNo——
enablemicrosoftdynamics365extensionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablemultiuserrepositoryfeaturesstringNo——
enablemultiuserrepositoryfeaturesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorapidatainstringNo——
enablenavigatorapidatainmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorapidataoutstringNo——
enablenavigatorapidataoutmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorapiutilitiesstringNo——
enablenavigatorapiutilitiesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorforhrstringNo——
enablenavigatorforhrmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorhierarchyaistringNo——
enablenavigatorhierarchyaimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorpartialingestionstringNo——
enablenavigatorpartialingestionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatortrialstringNo——
enablenavigatortrialmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenotaryondemandwitnessstringNo——
enablenotaryondemandwitnessmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableobligationmanagementstringNo——
enableobligationmanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableparticipantrecipientsettingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablepaymentprocessingstringNo—When true, payment processing is enabled for this account. Note: This setting can be changed only by Admin users, and only if the account-level setting allowPaymentProcessing is set.
enablepaymentprocessingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablepdfaconversionstringNo——
enablepdfaconversionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablepowerformstringNo—When true, enables PowerForms for the account. Note: Only SysAdmin users can change this setting.
enablepowerformdirectstringNo—When true, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms. Note: Only Admin users can change this setting.
enablepowerformdirectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablepowerformmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablepremiumdataverificationextensionsstringNo——
enablepremiumdataverificationextensionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablerecipientdomainvalidationstringNo—Reserved for Docusign.
enablerecipientdomainvalidationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablerecipientmayprovidephonenumberstringNo——
enablerecipientmayprovidephonenumbermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablereportlinksstringNo—Enables direct links to envelopes in reports for administrators in the following scopes: - NoEnvelopes - AllEnvelopes - OnlyOwnEnvelopes
enablereportlinksmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablerequiresignonpaperstringNo—When true, the account can use the requireSignOnPaper option. Note: Only Admin users can change this setting.
enablerequiresignonpapermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablereserveddomainstringNo—When true, account administrators can reserve a web domain and users. Domains are organization-specific reserved internet domains, such as @exampledomain.com. You can define policy settings for users of each reserved domain within your organization, export lists of domain users for audit purposes, and manage domain users. - Domains may be claimed by an organization. - When a domain is claimed by an organization, all users within that domain are added to the organization, even if they have trial or free accounts. - You can set domain controls for all users of the domain. - You can export information about your organization’s users that are associated with your reserved domains. Note: Only SysAdmin users can change this setting.
enablereserveddomainmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableresponsivesigningstringNo—When true, enables responsive signing.
enableresponsivesigningmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablereviewereventssettingstringNo——
enablereviewereventssettingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesaparibaextensionstringNo——
enablesaparibaextensionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablescheduledreleasestringNo—When true, scheduled releases are enabled. The default value is false.
enablescheduledreleasemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesearchserviceazureuristringNo——
enablesearchserviceazureurimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesearchsitespecificapistringNo——
enablesearchsitespecificapimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesendingtagsfontsettingsstringNo—When true, enables fonts to be set on tags for the account.
enablesendingtagsfontsettingsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesendtoagentstringNo—When true, this account can use the Agent recipient type. Note: Only SysAdmin users can change this setting.
enablesendtoagentmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesendtointermediarystringNo—When true, this account can use the Intermediary recipient type. Note: Only Admin users can change this setting, and only if allowSendToIntermediary is set.
enablesendtointermediarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesendtomanagestringNo—When true, this account can use the Editor recipient type. Note: Only Admin users can change this setting.
enablesendtomanagemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesequentialsigningapistringNo—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.
enablesequentialsigningapimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesequentialsigninguistringNo—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.
enablesequentialsigninguimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignerattachmentsstringNo—When true, users can use the signing attachments feature to request attachments from signers. Note: Only Admin users can change this setting.
enablesignerattachmentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesigningaifeaturesplanstringNo——
enablesigningaifeaturesplanmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesigningextensioncommentsstringNo—When true, enables comments for the account so that signers and recipients can make and respond to comments in documents belonging to the envelopes that they are sent.
enablesigningextensioncommentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesigningextensionconversationsstringNo—When true, enables conversation functionality.
enablesigningextensionconversationsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesigninggroupcontinuepagesettingstringNo——
enablesigninggroupcontinuepagesettingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesigningordersettingsforaccountstringNo—When true, switches Signing Order to On by default for new envelopes.
enablesigningordersettingsforaccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignonpaperstringNo—When true, a sender can allow signers to use the sign on paper option. Note: Only Admin users can change this setting.
enablesignonpapermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignonpaperoverridestringNo—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.
enablesignonpaperoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignwithnotarystringNo—When true, Sign with Notary functionality is enabled for the account. Note: Only Admin users can change this setting.
enablesignwithnotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesmartcontractsstringNo—When true, blockchain-based Smart Contracts are enabled. The default value is false.
enablesmartcontractsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesmsauthenticationstringNo—When true, the account can use SMS authentication. Note: Only Admin users can change this setting.
enablesmsauthenticationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesmsdeliveryadditionalnotificationstringNo——
enablesmsdeliveryadditionalnotificationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesmsdeliveryprimarystringNo——
enablesocialidloginstringNo—Deprecated.
enablesocialidloginmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablestrikethroughstringNo—When true, enables strikethrough formatting in documents.
enablestrikethroughmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableticketsstringNo——
enableticketsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabletransactionpointstringNo—Reserved for Docusign.
enabletransactionpointmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableunifiedrepositorystringNo——
enableunifiedrepositorymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablevaultingstringNo—When true, Vaulting is enabled for the account.
enablevaultingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablewebformsruntimeapisstringNo——
enablewebformsruntimeapismetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablewebformsseparateuserpermissionsstringNo——
enablewebformsseparateuserpermissionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablewitnessingstringNo—Reserved for Docusign.
enablewitnessingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableworkdayfinancialsextensionstringNo——
enableworkdayfinancialsextensionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableworkdayhrappstringNo——
enableworkdayhrappmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enforcetemplatenameuniquenessstringNo—When true, the template name must be unique.
enforcetemplatenameuniquenessmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enforcetlsemailsstringNo——
enforcetlsemailsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopeintegrationallowedstringNo—Shows the envelope integration rule for the account, which indicates whether custom admins can enable Connect for their accounts. Enumeration values are: - not_allowed - full Note: Only SysAdmin users can change this setting.
envelopeintegrationallowedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopeintegrationenabledstringNo—When true, enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account. Note: Only Admin users can change this setting, and only when envelopeIntegrationAllowed is set.
envelopeintegrationenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopelimitstotaldocumentsizeallowedinmbstringNo——
envelopelimitstotaldocumentsizeallowedinmbenabledstringNo——
envelopelimitstotaldocumentsizeallowedinmbenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopelimitstotaldocumentsizeallowedinmbmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopesearchmodestringNo——
envelopesearchmodemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopestampingdefaultvaluestringNo—When true, envelopes sent by this account automatically have the envelope ID stamped in the document margins, unless the sender selects not to have the documents stamped.
envelopestampingdefaultvaluemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
exitpromptstringNo——
exitpromptmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
expresssendstringNo—Boolean that specifies whether a member of an account can express send (without tags) or must send with tags on documents.
expresssendallowtabsstringNo—Boolean that specifies whether a member of an account can send templates without the tags being stripped out, even when the account is configured to let its users express send only (they cannot use the tagger).
expresssendallowtabsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
expresssendmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
externaldocumentsourcesjsonNo—A complex object specifying the external document sources.
externalsignaturepadtypestringNo—Specifies the signature pad type. Valid values are: - none - topaz - e_padv9 - e_pad_integrisign - topaz_sigplusextlite Note: Only Admin users can change this setting.
externalsignaturepadtypemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
faxoutenabledstringNo—When true, fax delivery to recipients is allowed for the account. Note: Only Admin users can change this setting.
faxoutenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
finishreminderstringNo——
finishremindermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
forbidaddinguserstampsstringNo——
forbidaddinguserstampsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
guidedformshtmlallowedstringNo—When true, HTML used to implement Guided Forms is enabled for the account.
guidedformshtmlallowedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
guidedformshtmlconversionpolicystringNo——
guidedformshtmlconversionpolicymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
hasrecipientconnectclaimeddomainstringNo——
hideaccountaddressincocstringNo—Boolean that specifies whether to hide the account address in the Certificate of Completion.
hideaccountaddressincocmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
hidepricingstringNo—Boolean that specifies whether to hide the pricing functionality for an account.
hidepricingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idcheckconfigurationslistNo—A list of ID check configuration objects.
idcheckexpirestringNo—Determines when a user's authentication with the account expires. Valid values are: - always: Users are required to authenticate each time. - variable: If the authentication for a user is valid and falls within the value for the idCheckExpireDays property, the user is not required to authenticate again. Note: Only Admin users can change this setting.
idcheckexpiredaysstringNo—The number of days before user authentication credentials expire. A value of 0 specifies that users must re-authenticate for each new session. Note: Only Admin users can change this setting.
idcheckexpiredaysmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idcheckexpiremetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idcheckexpireminutesstringNo—The number of minutes before user authentication credentials expire.
idcheckexpireminutesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idcheckrequiredstringNo—Indicates if authentication is configured for the account. Valid values are: - always: Authentication checks are performed on every envelope. - never: Authentication checks are not performed on any envelopes. - optional: Authentication is configurable per envelope. Note: Only Admin users can change this setting.
idcheckrequiredmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
identityverificationlistNo—Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other recipient authentication methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
identityverificationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idfxkbaauthenticationoverridestringNo——
idfxkbaauthenticationoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idfxphoneauthenticationoverridestringNo——
idfxphoneauthenticationoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
ignoreerrorifanchortabnotfoundstringNo—Reserved for Docusign.
ignoreerrorifanchortabnotfoundmetadataenabledjsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
inpersonidcheckquestionstringNo—A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient's response to this question is saved and can be viewed in the certificate associated with the envelope. Note: Only Admin users can change this setting.
inpersonidcheckquestionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
inpersonsigningenabledstringNo—When true, in-person signing is enabled for the account.
inpersonsigningenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
insessionenabledstringNo—When true, the account can send in-session (embedded) envelopes. Note: Only Admin users can change this setting.
insessionenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
insessionsuppressemailsstringNo—When true, emails are not sent to the in-session (embedded) recipients on an envelope. Note: Only Admin users can change this setting.
insessionsuppressemailsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
isconnectdocumentfieldsenabledstringNo——
isvembedstringNo——
isvembedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
isvoemembedstringNo——
isvoemembedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
linkedexternalprimaryaccountslistNo——
maestroplanlevelsstringNo——
maestroplanlevelsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
maximumsigninggroupsstringNo—The maximum number of signing groups allowed on the account. The default value is 50. This setting is only shown in responses that list account settings. Note: Only SysAdmin users can change this setting.
maximumsigninggroupsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
maximumuserspersigninggroupstringNo—The maximum number of users per signing group. The default value is 50. This setting is only shown in responses that list account settings. Note: Only SysAdmin users can change this setting.
maximumuserspersigninggroupmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
maxnumberofcustomstampsstringNo—The maximum number of custom stamps.
mergemixedmoderesultsstringNo——
mergemixedmoderesultsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
mobilesessiontimeoutstringNo—The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are 1 to 120 minutes. The default value is 20 minutes. Note: Only Admin users can change this setting.
mobilesessiontimeoutmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
numberofactivecustomstampsstringNo—The number of active custom stamps associated with the account. Docusign calculates this number automatically. This property is only visible to the Docusign account manager.
optinmobilesigningv02stringNo—Boolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality.
optinmobilesigningv02metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
optinuniversalsignaturesstringNo——
optoutautonavtextandtabcolorupdatesstringNo—Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color.
optoutautonavtextandtabcolorupdatesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
optoutnewplatformsealstringNo—Boolean that specifies whether to allow envelope senders to opt out of using the new platform seal.
optoutnewplatformsealplatformmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
originalaccountsitestringNo——
participantcopyoptoutstringNo——
participantcopyoptoutmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
pdfmaxchunkeduploadpartsizestringNo——
pdfmaxchunkeduploadpartsizemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
pdfmaxchunkeduploadtotalsizestringNo——
pdfmaxchunkeduploadtotalsizemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
pdfmaxindividualuploadsizestringNo——
pdfmaxindividualuploadsizemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
phoneauthrecipientmayprovidephonenumberstringNo—When true, senders can allow recipients to provide a phone number for the Phone Authentication process. Note: Only Admin users can change this setting.
phoneauthrecipientmayprovidephonenumbermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
pkisigndownloadedpdfdocsstringNo—The policy for adding a digital certificate to downloaded, printed, and emailed documents. Possible values are: - no_sign - no_sign_allow_user_override - yes_sign (Specifies that PDF files downloaded from the platform are signed.) Note: Only Admin users can change this setting.
pkisigndownloadedpdfdocsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
readonlymodestringNo——
readonlymodemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
recipientscansignofflinestringNo—When true, recipients receiving envelopes from this account can sign offline. Note: Only Admin users can change this setting.
recipientscansignofflinemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
recipientsigningautonavigationcontrolstringNo—When true, recipients receiving envelopes from this account can override auto-navigation functionality. Note: Only Admin users can change this setting.
recipientsigningautonavigationcontrolmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
recyclebinenveloperetentionstringNo——
recyclebinenveloperetentionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
require21cfrpt11compliancestringNo—When true, recipients are required to use a 21 CFR part 11-compliant signing experience. Note: Only Admin users can change this setting.
require21cfrpt11compliancemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
requiredeclinereasonstringNo—When true, signers who decline to sign an envelope sent from this account are required to provide a reason for declining. Note: Only Admin users can change this setting.
requiredeclinereasonmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
requireexternalusermanagementstringNo—When true, the account requires external management of users. Note: Only Admin users can change this setting.
requireexternalusermanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
requiresignercertificatetypestringNo—Sets the Digital Signature certificate requirements for sending envelopes. Valid values are: - none: A Digital Signature certificate is not required. - docusign_express: Signers must use a Docusign Express certificate. - docusign_personal: Signers must use a Docusign personal certificate. - safe - open_trust: Signers must use an OpenTrust certificate.
requiresignercertificatetypemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
rsaveridaccountnamestringNo—The RSA account name. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
rsaveridpasswordstringNo—The password for the RSA account. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
rsaveridrulesetstringNo—The RSA rule set used with the account. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
rsaveriduseridstringNo—The user ID for the RSA account. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
selfsignedrecipientemaildocumentstringNo—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.
selfsignedrecipientemaildocumentmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
selfsignedrecipientemaildocumentuseroverridestringNo—When true, the selfSignedRecipientEmailDocument user setting can be set for an individual user. The user setting overrides the account setting. Note: Only Admin users can change this account setting.
selfsignedrecipientemaildocumentuseroverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendercansignineachlocationstringNo—When true, a signer can draw their signature in each location where a sign or initial tab exists. This functionality is typically used for mobile signing. Note: Only Admin users can change this setting.
sendercansignineachlocationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendermustauthenticatesigningstringNo—When true, a sender who is also a recipient of an envelope must follow the authentication requirements for the envelope. Note: Only Admin users can change this setting.
sendermustauthenticatesigningmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendingtagsfontcolorstringNo—The account-wide default font color to use for the content of the tab. Valid values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
sendingtagsfontcolormetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendingtagsfontnamestringNo—The account-wide default font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
sendingtagsfontnamemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendingtagsfontsizestringNo—The account-wide default font size used for the information in the tab: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72
sendingtagsfontsizemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendlockoutrecipientnotificationstringNo——
sendlockoutrecipientnotificationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendtocertifieddeliveryenabledstringNo—When true, the account can use the certified deliveries recipient type.
sendtocertifieddeliveryenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sessiontimeoutstringNo—The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes.
sessiontimeoutmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
setrecipemaillangstringNo—When true, senders can set the email language to use for each recipient. Note: Only Admin users can change this setting.
setrecipemaillangmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
setrecipsignlangstringNo—When true, setting a unique language for a recipient not only affects the email language, but also the signing language they are presented with. When false, only the email will be affected when the sender specifies a unique language for a recipient. Note: Only Admin users can change this setting.
setrecipsignlangmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sharedtemplatefoldersstringNo—Boolean that specifies whether an account can use Shared Template Folders.
sharedtemplatefoldersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showcompletedialoginembeddedsessionstringNo—Boolean that specifies whether complete dialogs are displayed directly within an application in embedded signing sessions.
showcompletedialoginembeddedsessionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showconditionalroutingonsendstringNo—When true, Conditional Routing options display to senders during the sending experience.
showconditionalroutingonsendmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showinitialconditionalfieldsstringNo—Boolean that specifies whether conditional field options are initially displayed (before a user makes entries).
showinitialconditionalfieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showlocalizedwatermarksstringNo—Boolean that specifies whether localized watermarks are displayed.
showlocalizedwatermarksmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showmaskedfieldswhendownloadingdocumentassenderstringNo——
showmaskedfieldswhendownloadingdocumentassendermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showtutorialsstringNo—When true, show tutorials.
showtutorialsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signatureproviderslistNo—Names of electronic or digital signature providers that can be used.
signatureprovidersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signdateformatstringNo—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 Note: Only Admin users can change this setting.
signdateformatmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signdatetimeaccountlanguageoverridestringNo——
signdatetimeaccountlanguageoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signdatetimeaccounttimezoneoverridestringNo——
signdatetimeaccounttimezoneoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signerattachcertificatetoenvelopepdfstringNo—When true, the Certificate of Completion is included in the PDF of the envelope documents when it is downloaded. Note: Only Admin users can change this setting.
signerattachcertificatetoenvelopepdfmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signerattachconcatstringNo—When true, signer attachments are added to the parent document that contains the attachment. The default behavior creates a new document in the envelope for every signer attachment. Note: Only Admin users can change this setting.
signerattachconcatmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signercancreateaccountstringNo—When true, a signer can create a Docusign account after signing. Note: Only Admin users can change this setting.
signercancreateaccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signercansignonmobilestringNo—When true, recipients can sign on a mobile device. Note: Only Admin users can change this setting.
signercansignonmobilemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signerinsessionuseenvelopecompleteemailstringNo—When true, an "envelope complete" email is sent to an in-session (embedded) or offline signer after Docusign processes the envelope if in-session emails are not suppressed. Note: Only Admin users can change this setting.
signerinsessionuseenvelopecompleteemailmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signerloginrequirementsstringNo—Sets the login requirements for signers. Valid values are: - login_not_required: Signers are not required to log in. - login_required_if_account_holder: If the signer has a Docusign account, they must log in to sign the document. - login_required_per_session: The sender cannot send an envelope to anyone who does not have a Docusign account. - login_required_per_envelope: The sender cannot send an envelope to anyone who does not have a Docusign account, and the signer must also log in for each envelope they will sign. Note: Only Admin users can change this setting. If you use Direct PowerForms or captive (embedded signers), the "Account required" settings are bypassed for those signers. If your workflow requires that the signer have an account, you should not use those methods.
signerloginrequirementsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signermusthaveaccountstringNo—When true, senders can only send an envelope to a recipient that has a Docusign account. Note: Only Account Administrators can change this setting.
signermusthaveaccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signermustlogintosignstringNo—When true, signers must log in to the Docusign platform to sign an envelope. Note: Only Admin users can change this setting.
signermustlogintosignmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signershowsecurefieldinitialvaluesstringNo—When true, the initial values of all SecureFields are written to the document when it is sent. Note: Only Admin users can change this setting.
signershowsecurefieldinitialvaluesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signingsessiontimeoutstringNo—The number of minutes that a signing session stays alive without any activity.
signingsessiontimeoutmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signinguiversionstringNo—Reserved for Docusign.
signinguiversionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signtimeformatstringNo—The format for the signature time. Valid values are: - none - HH:mm - h:mm - HH:mm:ss - h:mm:ss
signtimeformatmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signtimeshowampmstringNo—When true, the time shows the AM or PM indicator.
signtimeshowampmmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
simplifiedsendingenabledstringNo—When true, simplified sending is enabled for the account. The default value is false.
simplifiedsendingenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
singlesignonenabledstringNo—When true, single sign-on (SSO) is enabled.
singlesignonenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
skipauthcompletedenvelopesstringNo—When true, do not require authentication prompt for viewing completed envelopes
skipauthcompletedenvelopesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
socialidrecipauthstringNo—When true, recipients can use social ids when signing
socialidrecipauthmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
specifydocumentvisibilitystringNo—When true, senders can specify the visibility of the documents in an envelope at the recipient level.
specifydocumentvisibilitymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
startinadvancedcorrectstringNo—When true, when initiating correction of an in-flight envelope the sender starts in advanced correct mode.
startinadvancedcorrectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
supplementaldocumentsmustacceptstringNo—When true, account users must accept supplemental documents when signing.
supplementaldocumentsmustacceptmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
supplementaldocumentsmustreadstringNo—When true, account users must both view and accept supplemental documents when signing.
supplementaldocumentsmustreadmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
supplementaldocumentsmustviewstringNo—When true, account users must view supplemental documents when signing.
supplementaldocumentsmustviewmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
suppresscertificateenforcementstringNo—Boolean that specifies whether or not API calls require a x509 cert in the header of the call.
suppresscertificateenforcementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
tabaccountsettingsjsonNo——
timezoneoffsetapistringNo—Specifies the time zone to use with the API. Valid values are: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
timezoneoffsetapimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
timezoneoffsetuistringNo—Specifies the time zone to use in the UI. Valid values are: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
timezoneoffsetuimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
universalsignatureoptinstringNo—Reserved for Docusign.
universalsignatureskipplatformsignaturestringNo——
universalsignatureskipplatformsignaturemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
useaccountlevelemailstringNo—Reserved for Docusign.
useaccountlevelemailmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
useconsumerdisclosurestringNo—When true, the account uses an Electronic Record and Signature Disclosure Statement. Note: Only Admin users can change this setting.
useconsumerdisclosuremetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
useconsumerdisclosurewithinaccountstringNo—When true, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.
useconsumerdisclosurewithinaccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usederivedkeysstringNo—Reserved for Docusign.
usederivedkeysmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usedocusignexpresssignercertificatestringNo—When true, signers are required to use Express Digital Signatures.
usedocusignexpresssignercertificatemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
useenvelopesearchmixedmodestringNo——
useenvelopesearchmixedmodemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usemultiappgroupsdatastringNo——
usemultiappgroupsdatametadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usenewblobforpdfstringNo—Reserved for Docusign.
usenewblobforpdfmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usenewenvelopesearchstringNo——
usenewenvelopesearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usenewenvelopesearchonlywhensearchingafterdatestringNo——
usenewenvelopesearchonlywhensearchingafterdatemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usenewenvelopesearchonlywithsearchtermstringNo——
usenewenvelopesearchonlywithsearchtermmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usesafesignercertificatesstringNo—When true, signers are required to use SAFE digital signatures.
usesafesignercertificatesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usesapistringNo—When true, the account can use the API. Note: Only SysAdmin users can change this setting.
usesapimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usesignatureproviderplatformstringNo—Boolean that specifies whether the account uses the digital signature provider platform to eSign.
usesignatureproviderplatformmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usesmartcontractsv1stringNo——
validationsallowedstringNo—Boolean that specifies whether validations on recipient email domains are allowed.
validationsallowedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
validationsbrandstringNo—Valid values are: - docusign - account
validationsbrandmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
validationscadencestringNo—Valid values are: - none - monthly
validationscadencemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
validationsenabledstringNo—When true, enables validations.
validationsenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
validationsreportstringNo—Valid values are: - none - life_sciences_part11
validationsreportmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
watermarkenabledstringNo—When true, the watermark feature is enabled for the account.
watermarkenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
writeremindertoenvelopehistorystringNo—When true, sent reminders are included in the envelope history.
writeremindertoenvelopehistorymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
wurflminallowablescreensizestringNo—The smallest screen allowed.
wurflminallowablescreensizemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.

Output Schema ​

FieldTypeRequiredDefaultDescription
base_urlstringYes—Docusign API root, e.g. https://<host>/api
api_tokenstringNo—Bearer token; omit to use the workflow's token env var
accountidstringYes—The external account number (int) or account ID GUID.
accesscodeformatjsonNo—Object specifying the format of the string provided to a recipient in order to access an envelope.
accountdatetimeformatstringNo—UTC date/time format for the account.
accountdatetimeformatmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
accountdefaultlanguagestringNo——
accountdefaultlanguagemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
accountnamestringNo—The name on the account.
accountnamemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
accountnotificationjsonNo—A complex element that specifies notifications (expirations and reminders) for the envelope.
accountuisettingsjsonNo—An object that defines the options that are available to non-administrators in the UI.
additionalsettingslistNo——
adoptsigconfigstringNo—When true, Signature Adoption Configuration is enabled. Note: Only Admin users can change this setting.
adoptsigconfigmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
advancedcorrectstringNo—When true, the Advanced Correction feature is enabled for this account.
advancedcorrectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
advancedsearchenabletabfieldstringNo——
advancedsearchenabletabfieldmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
advancedsearchenabletemplateidfieldstringNo——
advancedsearchenabletemplateidfieldmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
advancedsearchenabletemplatenamefieldstringNo——
advancedsearchenabletemplatenamefieldmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
aiassistedwebformcreationlevelstringNo——
aiassistedwebformcreationlevelmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowaccesscodeformatstringNo—When true, the configured Access Code Format page is enabled for account administrators. Note: Only Admin users can change this setting.
allowaccesscodeformatmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowaccountmanagementgranularstringNo—When true, the account can be managed on a per-user basis. Note: Only Admin users can change this setting.
allowaccountmanagementgranularmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowaccountmembernamechangestringNo—Boolean that specifies whether member names can be changed in the account.
allowaccountmembernamechangemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowacestringNo——
allowacemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowadvancedrecipientroutingconditionalstringNo—When true, Conditional Routing is enabled for the account as part of Docusign's Advanced Recipient Routing feature.
allowadvancedrecipientroutingconditionalmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowagentnameemaileditstringNo—When true, an agent recipient can change the email addresses of recipients later in the signing order.
allowagentnameemaileditmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowagreementactionsstringNo——
allowagreementactionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowagreementorchestrationsstringNo——
allowagreementorchestrationsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowautonavsettingsstringNo—When true, auto-navigation can be enabled for this account.
allowautonavsettingsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowautotaggingstringNo—When true, auto-tagging is enabled for the account.
allowautotaggingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowbulksendstringNo—When true, bulk send functionality is enabled for the account. Note: Only Admin users can change this setting.
allowbulksendmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowbyoidvstringNo——
allowbyoidvmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowcdwithdrawstringNo—When true, indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is false. Note: Only Admin users can change this setting.
allowcdwithdrawmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowconnectagreementuistringNo——
allowconnectagreementuimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowconnectauthoritativecopyreadyeventuistringNo——
allowconnectenveloperemindersenteventuistringNo——
allowconnectenveloperemovedeventstringNo——
allowconnectextensionuistringNo——
allowconnecthttplistenerconfigsstringNo—Boolean that specifies whether a Connect configuration can use HTTP listeners.
allowconnectidentityverificationuistringNo——
allowconnectoauthuistringNo——
allowconnectsendfinishlaterstringNo—Reserved for Docusign.
allowconnectsendfinishlatermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowconnectunifiedpayloaduistringNo——
allowconnectworkspaceuploadrequestuistringNo——
allowconsumerdisclosureoverridestringNo—When true, the account has the ability to change the Consumer Disclosure setting.
allowconsumerdisclosureoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdatadownloadstringNo—When true, senders can download form data from the envelopes that they send. Note: Only Admin users can change this setting.
allowdatadownloadmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdelayedroutingstringNo—"true" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, "false" otherwise.
allowdelayedroutingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdelegatedsigningstringNo——
allowdelegatedsigningmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdocgendocumentsstringNo——
allowdocgendocumentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdocumentdisclosuresstringNo—Boolean that specifies whether disclosure documents can be included in envelopes.
allowdocumentdisclosuresmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdocumentsonsignedenvelopesstringNo—Boolean that specifies whether notifications can include the envelope's signed document.
allowdocumentsonsignedenvelopesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowdocumentvisibilitystringNo—When true, the Document Visibility feature is enabled for the account.
allowdocumentvisibilitymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloweditingenvelopesonbehalfofothersstringNo——
alloweditingenvelopesonbehalfofothersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowehankostampsstringNo—When true, eHanko stamps are enabled.
allowehankostampsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenoteeoriginalstringNo—Specifies whether eNote eOriginal integration is enabled.
allowenoteeoriginalmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopecorrectstringNo—When true, the envelope correction feature is enabled. Note: Only Admin users can change this setting.
allowenvelopecorrectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopecustodytransferstringNo—Specifies whether the account is able to manage rules that transfer ownership of envelopes within the same account.
allowenvelopecustodytransfermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopecustomfieldsstringNo—Specifies whether envelope custom fields are enabled.
allowenvelopecustomfieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopepublishreportingstringNo—When true, envelope publishing reporting is enabled. Note: Only Admin users can change this setting.
allowenvelopepublishreportingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowenvelopereportingstringNo—Specifies whether the account has access to reports.
allowenvelopereportingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowexpressionstringNo—If the account plan does not include calculated fields, this setting allows an account to use them.
allowexpressionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowexpresssignercertificatestringNo—When true, signers are required to use Express Digital Signatures. Note: Only Admin users can change this setting.
allowexpresssignercertificatemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowextendedsendingresourcefilestringNo—Boolean that specifies whether resource files can be used for extended sending.
allowextendedsendingresourcefilemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowexternallinkedaccountsstringNo——
allowexternallinkedaccountsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowexternalsignaturepadstringNo—When true, the account can configure and use signature pads for their recipients. Note: Only Admin users can change this setting.
allowexternalsignaturepadmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowfedrampidvlevel1stringNo——
allowfedrampidvlevel1metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowfedrampidvlevel2stringNo——
allowfedrampidvlevel2metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvforeuqualifiedsignaturesstringNo——
allowidvforeuqualifiedsignaturesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvlevel1stringNo—When true, IDV Level 1 is allowed. The default value is false.
allowidvlevel1metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvlevel1trialstringNo——
allowidvlevel1trialmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvlevel2stringNo——
allowidvlevel2metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvlevel3stringNo——
allowidvlevel3metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvplatformstringNo——
allowidvplatformmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowidvriskassessmentstringNo——
allowidvriskassessmentmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowinpersonstringNo—When true, the account administrator can enable in-person signing. Note: Only SysAdmin users can change this setting.
allowinpersonelectronicnotarystringNo—Account-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.
allowinpersonelectronicnotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowinpersonmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmanagedstampsstringNo—When true, Managed Stamps are enabled.
allowmanagedstampsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmanagingenvelopesonbehalfofothersstringNo——
allowmanagingenvelopesonbehalfofothersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmarkupstringNo—When true, the Document Markup feature is enabled. Note: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.
allowmarkupmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmembertimezonestringNo—When true, account users can set their own time zone settings. Note: Only Admin users can change this setting.
allowmembertimezonemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmergefieldsstringNo—When true, the account can use merge fields with Docusign for Salesforce.
allowmergefieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmultiplebrandprofilesstringNo—Specifies whether the account supports multiple brands.
allowmultiplebrandprofilesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowmultiplesignerattachmentsstringNo—When true, recipients can upload multiple signer attachments with a single attachment. Note: Only Admin users can change this setting.
allowmultiplesignerattachmentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allownonusphoneauthstringNo—Specifies whether users can use international numbers for phone authentication.
allownonusphoneauthmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowocrofenvelopedocumentsstringNo——
allowocrofenvelopedocumentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowofflinesigningstringNo—When true, offline signing is enabled for the account. Note: Only Admin users can change this setting.
allowofflinesigningmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowonlystandalonewebformsstringNo——
allowonlystandalonewebformsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowopentrustsignercertificatestringNo—When true, senders can use OpenTrust signer certificates. Note: Only Admin users can change this setting.
allowopentrustsignercertificatemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationbrandingstringNo——
alloworganizationbrandingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationdocusignmonitorstringNo——
alloworganizationdocusignmonitorfreestringNo——
alloworganizationdocusignmonitorfreemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationdocusignmonitormetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationdomainusermanagementstringNo——
alloworganizationdomainusermanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationsstringNo—Boolean that specifies whether Docusign Admin is enabled for the account.
alloworganizationsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationssomanagementstringNo——
alloworganizationssomanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationtouseinpersonelectronicnotarystringNo—Organization-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.
alloworganizationtouseinpersonelectronicnotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationtouseremotenotarystringNo——
alloworganizationtouseremotenotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
alloworganizationtousethirdpartyelectronicnotarystringNo—Org level flag that determines the availability to perform Third Party Notary (3PN) actions.
alloworganizationtousethirdpartyelectronicnotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowparticipantrecipienttypestringNo——
allowparticipantrecipienttypemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowpaymentprocessingstringNo—When true, payment processing is enabled for the account. Note: Only Admin users can change this setting.
allowpaymentprocessingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowpendingdestinationurleditionstringNo——
allowpendingdestinationurleditionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowperformanceanalyticsstringNo——
allowperformanceanalyticsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowphoneauthenticationstringNo—Boolean that specifies whether phone authentication is enabled for the account.
allowphoneauthenticationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowphoneauthoverridestringNo—Boolean that specifies whether users can override phone authentication.
allowphoneauthoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowprivatesigninggroupsstringNo—Reserved for Docusign. This property returns the value false when listing account settings. This property is read-only.
allowprivatesigninggroupsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowrecipientconnectstringNo——
allowrecipientconnectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowremindersstringNo—When true, an account administrator can to turn on reminders and expiration defaults for the account. Note: Only Admin users can change this setting.
allowremindersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowremotenotarystringNo——
allowremotenotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowresourcefilebrandingstringNo—When true, resource files can be uploaded in branding.
allowresourcefilebrandingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsafebiopharmasignercertificatestringNo—When true, account administrators can specify that signers are required to use SAFE-BioPharma digital signatures. Note: Only Admin users can change this setting.
allowsafebiopharmasignercertificatemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowscheduledsendingstringNo—"true" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, "false" otherwise.
allowscheduledsendingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsecurityappliancestringNo—Boolean that specifies whether a Docusign Signature Appliance can be used with the account.
allowsecurityappliancemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsendingenvelopesonbehalfofothersstringNo——
allowsendingenvelopesonbehalfofothersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsendtocertifieddeliverystringNo—When true, the account admin can enable the Send to Certified Delivery feature on the account.
allowsendtocertifieddeliverymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsendtointermediarystringNo—When true, the account admin can enable the Send to Intermediary feature on the account.
allowsendtointermediarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowservertemplatesstringNo—When true, the account can use templates.
allowservertemplatesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsetembeddedrecipientstarturlstringNo——
allowsetembeddedrecipientstarturlmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsharedtabsstringNo—When true, shared tabs are enabled for the account. Note: Only Admin users can change this setting.
allowsharedtabsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsignaturestampsstringNo—When true, Signature Stamps are enabled. Note: Only Admin users can change this setting.
allowsignaturestampsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsigndocumentfromhomepagestringNo—When true, recipients can sign documents from the home page. Note: Only Admin users can change this setting.
allowsigndocumentfromhomepagemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsignerreassignstringNo—When true, the recipient of an envelope sent from this account can reassign it to another person. Note: Only Admin users can change this setting.
allowsignerreassignmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsignerreassignoverridestringNo—When true, an account administrator can override the ability of an envelope recipient to reassign it to another person. Note: Only Admin users can change this setting.
allowsignerreassignoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsigningextensionsstringNo—Boolean that specifies whether Signing and App Extensions are allowed.
allowsigningextensionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsigninggroupsstringNo—When true, the account allows signing groups. This setting is only shown in responses that list account settings. This property is read-only.
allowsigninggroupsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsigninginsightsstringNo——
allowsigninginsightsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsigningradiodeselectstringNo—Boolean that specifies whether the account supports radio buttons on tabs Radio CustomTabType.
allowsigningradiodeselectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsignnowstringNo—When true, the account administrator can enable the Sign Now feature.
allowsignnowmetadatastringNo—Metadata that indicates whether the allowSignNow property is editable.
allowsmsdeliverystringNo——
allowsmsdeliverymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsocialidloginstringNo—Deprecated.
allowsocialidloginmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowsupplementaldocumentsstringNo—When true, this user can include supplemental documents.
allowsupplementaldocumentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowthirdpartyelectronicnotarystringNo—Account level flag that determines the availability to perform Third Party Notary (3PN) actions.
allowthirdpartyelectronicnotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowtransactionsworkspacestringNo——
allowtransactionsworkspacemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowtransactionsworkspaceoriginalstringNo——
allowtransactionsworkspaceoriginalmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowuserstoaccessdirectorystringNo——
allowuserstoaccessdirectorymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowvalueinsightsstringNo——
allowvalueinsightsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowwebformsstringNo——
allowwebformsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
allowwhatsappdeliverystringNo——
allowwhatsappdeliverymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
anchorpopulationscopestringNo—This property determines how template anchor tabs are applied. Valid values are: - document: Anchor tabs are applied only to the document that you specify. - envelope: Anchor tabs are applied to all of the documents in the envelope associated with the template. Note: When you are using the anchorPopulationScope property with a Composite Template, the value document is supported only with a single server template and a single inline template.
anchorpopulationscopemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
anchortagversionedplacementenabledstringNo—Reserved for Docusign.
anchortagversionedplacementmetadataenabledjsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
attachcompletedenvelopestringNo—When true, envelope documents are included as a PDF file attachment to "signing completed" emails. Note: Only SysAdmin users can change this setting.
attachcompletedenvelopemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
authenticationcheckstringNo—Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: - Phone Authentication - SMS Authentication - Knowledge-Based ID This setting takes one of the following options: - initial_access: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account. - each_access: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable time frame. Note: Only Admin users can change this setting.
authenticationcheckmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
autonavrulestringNo—Specifies how auto-navigation works. Valid values are: - off - required_fields - required_and_blank_fields - all_fields - page_then_required_fields - page_then_required_and_blank_fields - page_then_all_fields
autonavrulemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
autoprovisionsigneraccountstringNo—Boolean that specifies whether to automatically provision a user membership in the account for accountless recipients. (Also known as Just-in-Time provisioning.)
autoprovisionsigneraccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
bccemailarchivestringNo—Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address.
bccemailarchivemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
betaswitchconfigurationstringNo—Reserved for Docusign.
betaswitchconfigurationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
billingaddressjsonNo—Contains address information.
billingaddressmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
bulksendstringNo—When true, this user can use the bulk send feature for the account.
bulksendactionresendlimitstringNo——
bulksendmaxcopiesinbatchstringNo——
bulksendmaxunprocessedenvelopescountstringNo——
bulksendmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
canselfbrandsendstringNo—When true, account administrators can self-brand their sending console through the Docusign console.
canselfbrandsendmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
canselfbrandsignstringNo—When true, account administrators can self-brand their signing console through the Docusign console.
canselfbrandsignmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
canusesalesforceoauthstringNo——
canusesalesforceoauthmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
capturevoicerecordingstringNo—Reserved for Docusign.
capturevoicerecordingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
cfr21simplifiedsigningenabledstringNo——
cfr21simplifiedsigningenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
cfrusewideimagestringNo—Boolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image.
cfrusewideimagemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
checkformultipleadminsonaccountstringNo——
checkformultipleadminsonaccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
chromesignatureenabledstringNo—Boolean that specifies whether the signers of the envelopes from this account use a signature with a Docusign chrome around it or not.
chromesignatureenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
cloudreadystringNo——
commentemailshowmessagetextstringNo—When true, the text of comments is included in email notifications when a comment is posted. Note: If the envelope requires additional recipient authentication, comment text is not included.
commentemailshowmessagetextmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
commentsallowenvelopeoverridestringNo—When true and comments are enabled for the account, senders can disable comments for an envelope through the Advanced Options menu that appears during the sending process.
commentsallowenvelopeoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
conditionalfieldsenabledstringNo—When true, conditional fields can be used in documents. Note: Only Admin users can change this setting.
conditionalfieldsenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
consumerdisclosurefrequencystringNo—Speficies how often to display the consumer disclosure. Valid values are: - once: Per account, the supplemental document is displayed once only per userId. - always: Per envelope, the supplemental document is displayed once only per userId. - each_access: Per envelope, the supplemental document is displayed once only per recipientId.
consumerdisclosurefrequencymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
convertpdffieldsstringNo—Boolean that specifies whether to enable PDF form fields to get converted to Docusign secure fields when the document is added or uploaded to an envelope.
convertpdffieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
customextractionplanlevelsstringNo——
customextractionplanlevelsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
datapopulationscopestringNo—Specifies how data is shared for tabs with the same tabLabel. Valid values are: - document: Tabs in a document with the same label populate with the same data. - envelope: Tabs in all documents in the envelope with the same label populate with the same data. - notset: Use the global account setting. This setting applies to the following tab types: - Check box - Company - Data field - Drop-down list - Full name - Formula - Note - Title Note: Only Admin users can change this setting. Changing this setting affects envelopes that have been sent but not completed.
datapopulationscopemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
defaultsigningresponsiveviewstringNo——
defaultsigningresponsiveviewmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
defaultsigningresponsiveviewusegradestringNo——
defaultsigningresponsiveviewusegrademetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
defaulttoadvancedenvelopesfilterformstringNo——
defaulttoadvancedenvelopesfilterformmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disableautotemplatematchingstringNo——
disableautotemplatematchingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablelegacykbastringNo——
disablelegacykbametadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablelegacysharedenvelopesstringNo——
disablelegacysharedenvelopesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablemobileappstringNo—When true, the mobile app distributor key is prevented from connecting for account users.
disablemobileappmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablemobilepushnotificationsstringNo—When true, push notifications are disabled for the account. Note: Only Admin users can change this setting.
disablemobilepushnotificationsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablemobilesendingstringNo—When true, sending from a mobile application is disabled. Note: Only Admin users can change this setting.
disablemobilesendingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablemultiplesessionsstringNo—When true, account users cannot be logged into multiple sessions at the same time. Note: Only Admin users can change this setting.
disablemultiplesessionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablepurgenotificationsforsendermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablesignercertviewstringNo—When true, signers cannot view certificates of completion.
disablesignercertviewmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablesignerhistoryviewstringNo—When true, signers cannot view envelope history.
disablesignerhistoryviewmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disablestylesignaturestringNo—When true, the Select Style option is hidden from signers and they must draw their signature instead.
disablestylesignaturemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disableuploadsignaturestringNo—When true, signers cannot upload custom image files of their signature and initials. Note: Only Admin users can change this setting.
disableuploadsignaturemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
disableusersharingstringNo—When true, the User Sharing feature is disabled for the account.
disableusersharingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
displaybetaswitchstringNo—Boolean that specifies whether to display a Beta switch for your app.
displaybetaswitchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
documentconversionrestrictionsstringNo—Sets the account document upload restriction for non-account administrators. Valid values are: - no_restrictions: There are no restrictions on the type of documents that can be uploaded. - allow_pdf_only: Non-administrators can only upload PDF files. - no_upload: Non-administrators cannot upload files. Note: Only Admin users can change this setting.
documentconversionrestrictionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
documentretentionstringNo—Sets a document retention period, which controls the number of days that Docusign retains documents after they have reached a completed,declined, or voided state. When document retention is enabled for the account, the default value is 356 days.
documentretentionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
documentretentionpurgetabsstringNo—When true and documentRetention is set, document fields and metadata are also purged after the document retention period ends. The default value is false. Note: Only Admins can change this setting.
documentvisibilitystringNo—Configures the Document Visibility feature for the account. Valid values are: - Off: Document Visibility is not active for the account. - MustSignToViewUnlessSenderAccount: Document Visibility is enabled for all envelopes sent from the account. Any member of the sending account can view all of the documents in an envelope. - MustSignToViewUnlessSender: Document Visibility is enabled for all envelopes sent from the account. Only the sender can view all of the documents in an envelope. - SenderCanSetMustSignToViewUnlessSenderAccount: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents within it are still visible to any member of the sending account. Vd- SenderCanSetMustSignToViewUnlessSender: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents in the envelope are visible only to the sender. Note: For this configuration to take effect, allowDocumentVisibility must be set to true.
documentvisibilitymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
draftenveloperetentionstringNo——
draftenveloperetentionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
dss_sign_28411_enableleavepageprompt_radminoptionstringNo——
dss_sign_29182_slideupbar_radminoptionstringNo——
emailtemplateversionstringNo—Specifies the version of the email templates used in an account. If new signing is selected in a member's Admin page, the user is updated to the newest version (1.1), the minimum version of email supported for the account.
emailtemplateversionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaccesscodegeneratorstringNo—When true, enables Access Code Generator on the account.
enableaccesscodegeneratormetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaccountwidesearchstringNo——
enableaccountwidesearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadditionaladvancedwebformsfeaturesstringNo——
enableadditionaladvancedwebformsfeaturesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadmhealthcarestringNo—Account Level Flag that determines the availability to use ADM Healthcare fields
enableadmhealthcaremetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadvancedenvelopessearchstringNo——
enableadvancedenvelopessearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadvancedpaymentsstringNo—When true, enables Advanced Payments for the account.
enableadvancedpaymentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadvancedpowerformsstringNo—When true, enables advanced PowerForms for the account.
enableadvancedpowerformsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableadvancedsearchstringNo——
enableadvancedsearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableagreementactionsforclmstringNo——
enableagreementactionsforclmmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableagreementactionsforesignstringNo——
enableagreementactionsforesignmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableagreementdeskadvancedstringNo——
enableagreementdeskadvancedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaiagentsstringNo——
enableaiagentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaicontractreviewstringNo——
enableaicontractreviewmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaisendermessagestringNo——
enableaisendermessagemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaisuggestedfieldsstringNo——
enableaisuggestedfieldsautoplacestringNo——
enableaisuggestedfieldsautoplacemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableaisuggestedfieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableautonavstringNo—When true, enables the account to set the AutoNav rule setting, which enables a sender to override the auto-navigation setting per envelope. Note: To change this setting, you must be a SysAdmin user or `EnableAutoNavByDSAdmin must be set.
enableautonavmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablebatchupdateenvelopetypesstringNo——
enablebatchupdateenvelopetypesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablebccdummylinkstringNo——
enablebccdummylinkmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecacpivsignaturegroupstringNo——
enablecacpivsignaturegroupmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecalculatedfieldsstringNo—When true, calculated fields are enabled for the account. Note: This setting can be changed only by Admin users, and only if the account-level setting allowExpression is set to true.
enablecalculatedfieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecfrrapidsigningembeddedauthstringNo——
enablecfrrapidsigningembeddedauthmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickplusstringNo——
enableclickplusconditionalcontentstringNo——
enableclickplusconditionalcontentmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickpluscustomfieldsstringNo——
enableclickpluscustomfieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickpluscustomstylestringNo——
enableclickpluscustomstylemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickplusdynamiccontentstringNo——
enableclickplusdynamiccontentmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickplusmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableclickwrapsstringNo—Boolean that specifies whether clickwraps are enabled in your app. A clickwrap is an iframe that you embed in your own website or app.
enableclickwrapsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecombinedpdfdownloadforsbsstringNo——
enablecommentshistorydownloadinsigningstringNo——
enablecommentshistorydownloadinsigningmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecontactsuggestionsstringNo——
enablecontactsuggestionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecontentsearchstringNo——
enablecontentsearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecoupacoreextensionstringNo——
enablecoupacoreextensionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecoupaiamconnectorstringNo——
enablecoupaiamconnectormetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecustomdataverificationextensionsstringNo——
enablecustomdataverificationextensionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablecustomersatisfactionmetrictrackingstringNo—When true, enables customer satisfaction metric tracking for the account.
enablecustomersatisfactionmetrictrackingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledataverificationextensionsstringNo——
enabledataverificationextensionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledocumenttemplatelibrarystringNo——
enabledocumenttemplatelibrarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigeuadvancedpensstringNo——
enabledsigeuadvancedpensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigexpresspensstringNo——
enabledsigexpresspensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigidcheckforaespensstringNo——
enabledsigidcheckforaespensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigidcheckinpersonforqespensstringNo——
enabledsigidcheckinpersonforqespensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigidcheckremoteforqespensstringNo——
enabledsigidcheckremoteforqespensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigidverificationpensstringNo——
enabledsigidverificationpensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigidverificationpremierpensstringNo——
enabledsigidverificationpremierpensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigpengroupeuqesstringNo——
enabledsigpengroupeuqesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsigplgeuqespensstringNo——
enabledsigplgeuqespensmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabledsprostringNo—Reserved for Docusign.
enabledsprometadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableenforcetlsemailssettingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableenvelopestampingbyaccountadminstringNo—When true, enables the account administrator to control envelope stamping for an account (stamping the envelopeId in the document margins). Note: This setting can be changed only by Admin users, and only if the account-level setting enableEnvelopeStampingByDSAdmin is set to true.
enableenvelopestampingbyaccountadminmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableenvelopestampingbydsadminstringNo—When true, enables the Docusign administrator to control envelope stamping for an account (placement of the envelopeId).
enableenvelopestampingbydsadminmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableesignapihourlylimitmanagementstringNo——
enableesignapihourlylimitmanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableesigncommunitiesstringNo——
enableesigncommunitiesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableesigntaskliststringNo——
enableesigntasklistmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablegenerationwith3pintegrationstringNo——
enablegenerationwith3pintegrationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablegreenhouseappstringNo——
enablegreenhouseappmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablei9ondemandstringNo——
enablei9ondemandmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableiamclauselibrarystringNo——
enableiamclauselibrarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableiamforxembeddeduxstringNo——
enableiamforxembeddeduxmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableidfxaccountlesssmsauthforpart11stringNo——
enableidfxaccountlesssmsauthforpart11metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableidfxintuitkbastringNo——
enableidfxintuitkbametadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableidfxphoneauthenticationstringNo——
enableidfxphoneauthenticationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableidfxphoneauthsignatureauthstatusstringNo——
enableidfxphoneauthsignatureauthstatusmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableinboxbrowseviewspoweredbyelasticsearchstringNo——
enableinboxbrowseviewspoweredbyelasticsearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableinboxrelevancesortstringNo——
enableinboxrelevancesortmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableinbrowsereditorstringNo——
enableinbrowsereditormetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablekeytermssuggestionsbydocumenttypestringNo——
enablekeytermssuggestionsbydocumenttypemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablelargefilesupportstringNo——
enablelargefilesupportmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablelegacysharedenvelopesstringNo——
enablelegacysharedenvelopesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablelicensemanagementstringNo——
enablelicensemanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablemicrosoftdynamics365extensionstringNo——
enablemicrosoftdynamics365extensionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablemultiuserrepositoryfeaturesstringNo——
enablemultiuserrepositoryfeaturesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorapidatainstringNo——
enablenavigatorapidatainmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorapidataoutstringNo——
enablenavigatorapidataoutmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorapiutilitiesstringNo——
enablenavigatorapiutilitiesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorforhrstringNo——
enablenavigatorforhrmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorhierarchyaistringNo——
enablenavigatorhierarchyaimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatorpartialingestionstringNo——
enablenavigatorpartialingestionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenavigatortrialstringNo——
enablenavigatortrialmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablenotaryondemandwitnessstringNo——
enablenotaryondemandwitnessmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableobligationmanagementstringNo——
enableobligationmanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableparticipantrecipientsettingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablepaymentprocessingstringNo—When true, payment processing is enabled for this account. Note: This setting can be changed only by Admin users, and only if the account-level setting allowPaymentProcessing is set.
enablepaymentprocessingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablepdfaconversionstringNo——
enablepdfaconversionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablepowerformstringNo—When true, enables PowerForms for the account. Note: Only SysAdmin users can change this setting.
enablepowerformdirectstringNo—When true, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms. Note: Only Admin users can change this setting.
enablepowerformdirectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablepowerformmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablepremiumdataverificationextensionsstringNo——
enablepremiumdataverificationextensionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablerecipientdomainvalidationstringNo—Reserved for Docusign.
enablerecipientdomainvalidationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablerecipientmayprovidephonenumberstringNo——
enablerecipientmayprovidephonenumbermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablereportlinksstringNo—Enables direct links to envelopes in reports for administrators in the following scopes: - NoEnvelopes - AllEnvelopes - OnlyOwnEnvelopes
enablereportlinksmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablerequiresignonpaperstringNo—When true, the account can use the requireSignOnPaper option. Note: Only Admin users can change this setting.
enablerequiresignonpapermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablereserveddomainstringNo—When true, account administrators can reserve a web domain and users. Domains are organization-specific reserved internet domains, such as @exampledomain.com. You can define policy settings for users of each reserved domain within your organization, export lists of domain users for audit purposes, and manage domain users. - Domains may be claimed by an organization. - When a domain is claimed by an organization, all users within that domain are added to the organization, even if they have trial or free accounts. - You can set domain controls for all users of the domain. - You can export information about your organization’s users that are associated with your reserved domains. Note: Only SysAdmin users can change this setting.
enablereserveddomainmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableresponsivesigningstringNo—When true, enables responsive signing.
enableresponsivesigningmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablereviewereventssettingstringNo——
enablereviewereventssettingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesaparibaextensionstringNo——
enablesaparibaextensionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablescheduledreleasestringNo—When true, scheduled releases are enabled. The default value is false.
enablescheduledreleasemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesearchserviceazureuristringNo——
enablesearchserviceazureurimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesearchsitespecificapistringNo——
enablesearchsitespecificapimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesendingtagsfontsettingsstringNo—When true, enables fonts to be set on tags for the account.
enablesendingtagsfontsettingsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesendtoagentstringNo—When true, this account can use the Agent recipient type. Note: Only SysAdmin users can change this setting.
enablesendtoagentmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesendtointermediarystringNo—When true, this account can use the Intermediary recipient type. Note: Only Admin users can change this setting, and only if allowSendToIntermediary is set.
enablesendtointermediarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesendtomanagestringNo—When true, this account can use the Editor recipient type. Note: Only Admin users can change this setting.
enablesendtomanagemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesequentialsigningapistringNo—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.
enablesequentialsigningapimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesequentialsigninguistringNo—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.
enablesequentialsigninguimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignerattachmentsstringNo—When true, users can use the signing attachments feature to request attachments from signers. Note: Only Admin users can change this setting.
enablesignerattachmentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesigningaifeaturesplanstringNo——
enablesigningaifeaturesplanmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesigningextensioncommentsstringNo—When true, enables comments for the account so that signers and recipients can make and respond to comments in documents belonging to the envelopes that they are sent.
enablesigningextensioncommentsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesigningextensionconversationsstringNo—When true, enables conversation functionality.
enablesigningextensionconversationsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesigninggroupcontinuepagesettingstringNo——
enablesigninggroupcontinuepagesettingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesigningordersettingsforaccountstringNo—When true, switches Signing Order to On by default for new envelopes.
enablesigningordersettingsforaccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignonpaperstringNo—When true, a sender can allow signers to use the sign on paper option. Note: Only Admin users can change this setting.
enablesignonpapermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignonpaperoverridestringNo—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.
enablesignonpaperoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesignwithnotarystringNo—When true, Sign with Notary functionality is enabled for the account. Note: Only Admin users can change this setting.
enablesignwithnotarymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesmartcontractsstringNo—When true, blockchain-based Smart Contracts are enabled. The default value is false.
enablesmartcontractsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesmsauthenticationstringNo—When true, the account can use SMS authentication. Note: Only Admin users can change this setting.
enablesmsauthenticationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesmsdeliveryadditionalnotificationstringNo——
enablesmsdeliveryadditionalnotificationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablesmsdeliveryprimarystringNo——
enablesocialidloginstringNo—Deprecated.
enablesocialidloginmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablestrikethroughstringNo—When true, enables strikethrough formatting in documents.
enablestrikethroughmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableticketsstringNo——
enableticketsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enabletransactionpointstringNo—Reserved for Docusign.
enabletransactionpointmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableunifiedrepositorystringNo——
enableunifiedrepositorymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablevaultingstringNo—When true, Vaulting is enabled for the account.
enablevaultingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablewebformsruntimeapisstringNo——
enablewebformsruntimeapismetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablewebformsseparateuserpermissionsstringNo——
enablewebformsseparateuserpermissionsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enablewitnessingstringNo—Reserved for Docusign.
enablewitnessingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableworkdayfinancialsextensionstringNo——
enableworkdayfinancialsextensionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enableworkdayhrappstringNo——
enableworkdayhrappmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enforcetemplatenameuniquenessstringNo—When true, the template name must be unique.
enforcetemplatenameuniquenessmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
enforcetlsemailsstringNo——
enforcetlsemailsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopeintegrationallowedstringNo—Shows the envelope integration rule for the account, which indicates whether custom admins can enable Connect for their accounts. Enumeration values are: - not_allowed - full Note: Only SysAdmin users can change this setting.
envelopeintegrationallowedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopeintegrationenabledstringNo—When true, enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account. Note: Only Admin users can change this setting, and only when envelopeIntegrationAllowed is set.
envelopeintegrationenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopelimitstotaldocumentsizeallowedinmbstringNo——
envelopelimitstotaldocumentsizeallowedinmbenabledstringNo——
envelopelimitstotaldocumentsizeallowedinmbenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopelimitstotaldocumentsizeallowedinmbmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopesearchmodestringNo——
envelopesearchmodemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
envelopestampingdefaultvaluestringNo—When true, envelopes sent by this account automatically have the envelope ID stamped in the document margins, unless the sender selects not to have the documents stamped.
envelopestampingdefaultvaluemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
exitpromptstringNo——
exitpromptmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
expresssendstringNo—Boolean that specifies whether a member of an account can express send (without tags) or must send with tags on documents.
expresssendallowtabsstringNo—Boolean that specifies whether a member of an account can send templates without the tags being stripped out, even when the account is configured to let its users express send only (they cannot use the tagger).
expresssendallowtabsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
expresssendmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
externaldocumentsourcesjsonNo—A complex object specifying the external document sources.
externalsignaturepadtypestringNo—Specifies the signature pad type. Valid values are: - none - topaz - e_padv9 - e_pad_integrisign - topaz_sigplusextlite Note: Only Admin users can change this setting.
externalsignaturepadtypemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
faxoutenabledstringNo—When true, fax delivery to recipients is allowed for the account. Note: Only Admin users can change this setting.
faxoutenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
finishreminderstringNo——
finishremindermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
forbidaddinguserstampsstringNo——
forbidaddinguserstampsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
guidedformshtmlallowedstringNo—When true, HTML used to implement Guided Forms is enabled for the account.
guidedformshtmlallowedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
guidedformshtmlconversionpolicystringNo——
guidedformshtmlconversionpolicymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
hasrecipientconnectclaimeddomainstringNo——
hideaccountaddressincocstringNo—Boolean that specifies whether to hide the account address in the Certificate of Completion.
hideaccountaddressincocmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
hidepricingstringNo—Boolean that specifies whether to hide the pricing functionality for an account.
hidepricingmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idcheckconfigurationslistNo—A list of ID check configuration objects.
idcheckexpirestringNo—Determines when a user's authentication with the account expires. Valid values are: - always: Users are required to authenticate each time. - variable: If the authentication for a user is valid and falls within the value for the idCheckExpireDays property, the user is not required to authenticate again. Note: Only Admin users can change this setting.
idcheckexpiredaysstringNo—The number of days before user authentication credentials expire. A value of 0 specifies that users must re-authenticate for each new session. Note: Only Admin users can change this setting.
idcheckexpiredaysmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idcheckexpiremetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idcheckexpireminutesstringNo—The number of minutes before user authentication credentials expire.
idcheckexpireminutesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idcheckrequiredstringNo—Indicates if authentication is configured for the account. Valid values are: - always: Authentication checks are performed on every envelope. - never: Authentication checks are not performed on any envelopes. - optional: Authentication is configurable per envelope. Note: Only Admin users can change this setting.
idcheckrequiredmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
identityverificationlistNo—Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other recipient authentication methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).
identityverificationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idfxkbaauthenticationoverridestringNo——
idfxkbaauthenticationoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
idfxphoneauthenticationoverridestringNo——
idfxphoneauthenticationoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
ignoreerrorifanchortabnotfoundstringNo—Reserved for Docusign.
ignoreerrorifanchortabnotfoundmetadataenabledjsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
inpersonidcheckquestionstringNo—A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient's response to this question is saved and can be viewed in the certificate associated with the envelope. Note: Only Admin users can change this setting.
inpersonidcheckquestionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
inpersonsigningenabledstringNo—When true, in-person signing is enabled for the account.
inpersonsigningenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
insessionenabledstringNo—When true, the account can send in-session (embedded) envelopes. Note: Only Admin users can change this setting.
insessionenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
insessionsuppressemailsstringNo—When true, emails are not sent to the in-session (embedded) recipients on an envelope. Note: Only Admin users can change this setting.
insessionsuppressemailsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
isconnectdocumentfieldsenabledstringNo——
isvembedstringNo——
isvembedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
isvoemembedstringNo——
isvoemembedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
linkedexternalprimaryaccountslistNo——
maestroplanlevelsstringNo——
maestroplanlevelsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
maximumsigninggroupsstringNo—The maximum number of signing groups allowed on the account. The default value is 50. This setting is only shown in responses that list account settings. Note: Only SysAdmin users can change this setting.
maximumsigninggroupsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
maximumuserspersigninggroupstringNo—The maximum number of users per signing group. The default value is 50. This setting is only shown in responses that list account settings. Note: Only SysAdmin users can change this setting.
maximumuserspersigninggroupmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
maxnumberofcustomstampsstringNo—The maximum number of custom stamps.
mergemixedmoderesultsstringNo——
mergemixedmoderesultsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
mobilesessiontimeoutstringNo—The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are 1 to 120 minutes. The default value is 20 minutes. Note: Only Admin users can change this setting.
mobilesessiontimeoutmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
numberofactivecustomstampsstringNo—The number of active custom stamps associated with the account. Docusign calculates this number automatically. This property is only visible to the Docusign account manager.
optinmobilesigningv02stringNo—Boolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality.
optinmobilesigningv02metadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
optinuniversalsignaturesstringNo——
optoutautonavtextandtabcolorupdatesstringNo—Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color.
optoutautonavtextandtabcolorupdatesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
optoutnewplatformsealstringNo—Boolean that specifies whether to allow envelope senders to opt out of using the new platform seal.
optoutnewplatformsealplatformmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
originalaccountsitestringNo——
participantcopyoptoutstringNo——
participantcopyoptoutmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
pdfmaxchunkeduploadpartsizestringNo——
pdfmaxchunkeduploadpartsizemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
pdfmaxchunkeduploadtotalsizestringNo——
pdfmaxchunkeduploadtotalsizemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
pdfmaxindividualuploadsizestringNo——
pdfmaxindividualuploadsizemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
phoneauthrecipientmayprovidephonenumberstringNo—When true, senders can allow recipients to provide a phone number for the Phone Authentication process. Note: Only Admin users can change this setting.
phoneauthrecipientmayprovidephonenumbermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
pkisigndownloadedpdfdocsstringNo—The policy for adding a digital certificate to downloaded, printed, and emailed documents. Possible values are: - no_sign - no_sign_allow_user_override - yes_sign (Specifies that PDF files downloaded from the platform are signed.) Note: Only Admin users can change this setting.
pkisigndownloadedpdfdocsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
readonlymodestringNo——
readonlymodemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
recipientscansignofflinestringNo—When true, recipients receiving envelopes from this account can sign offline. Note: Only Admin users can change this setting.
recipientscansignofflinemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
recipientsigningautonavigationcontrolstringNo—When true, recipients receiving envelopes from this account can override auto-navigation functionality. Note: Only Admin users can change this setting.
recipientsigningautonavigationcontrolmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
recyclebinenveloperetentionstringNo——
recyclebinenveloperetentionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
require21cfrpt11compliancestringNo—When true, recipients are required to use a 21 CFR part 11-compliant signing experience. Note: Only Admin users can change this setting.
require21cfrpt11compliancemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
requiredeclinereasonstringNo—When true, signers who decline to sign an envelope sent from this account are required to provide a reason for declining. Note: Only Admin users can change this setting.
requiredeclinereasonmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
requireexternalusermanagementstringNo—When true, the account requires external management of users. Note: Only Admin users can change this setting.
requireexternalusermanagementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
requiresignercertificatetypestringNo—Sets the Digital Signature certificate requirements for sending envelopes. Valid values are: - none: A Digital Signature certificate is not required. - docusign_express: Signers must use a Docusign Express certificate. - docusign_personal: Signers must use a Docusign personal certificate. - safe - open_trust: Signers must use an OpenTrust certificate.
requiresignercertificatetypemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
rsaveridaccountnamestringNo—The RSA account name. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
rsaveridpasswordstringNo—The password for the RSA account. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
rsaveridrulesetstringNo—The RSA rule set used with the account. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
rsaveriduseridstringNo—The user ID for the RSA account. Note: Only Admin users can change this setting. Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.
selfsignedrecipientemaildocumentstringNo—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.
selfsignedrecipientemaildocumentmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
selfsignedrecipientemaildocumentuseroverridestringNo—When true, the selfSignedRecipientEmailDocument user setting can be set for an individual user. The user setting overrides the account setting. Note: Only Admin users can change this account setting.
selfsignedrecipientemaildocumentuseroverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendercansignineachlocationstringNo—When true, a signer can draw their signature in each location where a sign or initial tab exists. This functionality is typically used for mobile signing. Note: Only Admin users can change this setting.
sendercansignineachlocationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendermustauthenticatesigningstringNo—When true, a sender who is also a recipient of an envelope must follow the authentication requirements for the envelope. Note: Only Admin users can change this setting.
sendermustauthenticatesigningmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendingtagsfontcolorstringNo—The account-wide default font color to use for the content of the tab. Valid values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
sendingtagsfontcolormetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendingtagsfontnamestringNo—The account-wide default font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
sendingtagsfontnamemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendingtagsfontsizestringNo—The account-wide default font size used for the information in the tab: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72
sendingtagsfontsizemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendlockoutrecipientnotificationstringNo——
sendlockoutrecipientnotificationmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sendtocertifieddeliveryenabledstringNo—When true, the account can use the certified deliveries recipient type.
sendtocertifieddeliveryenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sessiontimeoutstringNo—The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes.
sessiontimeoutmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
setrecipemaillangstringNo—When true, senders can set the email language to use for each recipient. Note: Only Admin users can change this setting.
setrecipemaillangmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
setrecipsignlangstringNo—When true, setting a unique language for a recipient not only affects the email language, but also the signing language they are presented with. When false, only the email will be affected when the sender specifies a unique language for a recipient. Note: Only Admin users can change this setting.
setrecipsignlangmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
sharedtemplatefoldersstringNo—Boolean that specifies whether an account can use Shared Template Folders.
sharedtemplatefoldersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showcompletedialoginembeddedsessionstringNo—Boolean that specifies whether complete dialogs are displayed directly within an application in embedded signing sessions.
showcompletedialoginembeddedsessionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showconditionalroutingonsendstringNo—When true, Conditional Routing options display to senders during the sending experience.
showconditionalroutingonsendmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showinitialconditionalfieldsstringNo—Boolean that specifies whether conditional field options are initially displayed (before a user makes entries).
showinitialconditionalfieldsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showlocalizedwatermarksstringNo—Boolean that specifies whether localized watermarks are displayed.
showlocalizedwatermarksmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showmaskedfieldswhendownloadingdocumentassenderstringNo——
showmaskedfieldswhendownloadingdocumentassendermetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
showtutorialsstringNo—When true, show tutorials.
showtutorialsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signatureproviderslistNo—Names of electronic or digital signature providers that can be used.
signatureprovidersmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signdateformatstringNo—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 Note: Only Admin users can change this setting.
signdateformatmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signdatetimeaccountlanguageoverridestringNo——
signdatetimeaccountlanguageoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signdatetimeaccounttimezoneoverridestringNo——
signdatetimeaccounttimezoneoverridemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signerattachcertificatetoenvelopepdfstringNo—When true, the Certificate of Completion is included in the PDF of the envelope documents when it is downloaded. Note: Only Admin users can change this setting.
signerattachcertificatetoenvelopepdfmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signerattachconcatstringNo—When true, signer attachments are added to the parent document that contains the attachment. The default behavior creates a new document in the envelope for every signer attachment. Note: Only Admin users can change this setting.
signerattachconcatmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signercancreateaccountstringNo—When true, a signer can create a Docusign account after signing. Note: Only Admin users can change this setting.
signercancreateaccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signercansignonmobilestringNo—When true, recipients can sign on a mobile device. Note: Only Admin users can change this setting.
signercansignonmobilemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signerinsessionuseenvelopecompleteemailstringNo—When true, an "envelope complete" email is sent to an in-session (embedded) or offline signer after Docusign processes the envelope if in-session emails are not suppressed. Note: Only Admin users can change this setting.
signerinsessionuseenvelopecompleteemailmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signerloginrequirementsstringNo—Sets the login requirements for signers. Valid values are: - login_not_required: Signers are not required to log in. - login_required_if_account_holder: If the signer has a Docusign account, they must log in to sign the document. - login_required_per_session: The sender cannot send an envelope to anyone who does not have a Docusign account. - login_required_per_envelope: The sender cannot send an envelope to anyone who does not have a Docusign account, and the signer must also log in for each envelope they will sign. Note: Only Admin users can change this setting. If you use Direct PowerForms or captive (embedded signers), the "Account required" settings are bypassed for those signers. If your workflow requires that the signer have an account, you should not use those methods.
signerloginrequirementsmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signermusthaveaccountstringNo—When true, senders can only send an envelope to a recipient that has a Docusign account. Note: Only Account Administrators can change this setting.
signermusthaveaccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signermustlogintosignstringNo—When true, signers must log in to the Docusign platform to sign an envelope. Note: Only Admin users can change this setting.
signermustlogintosignmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signershowsecurefieldinitialvaluesstringNo—When true, the initial values of all SecureFields are written to the document when it is sent. Note: Only Admin users can change this setting.
signershowsecurefieldinitialvaluesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signingsessiontimeoutstringNo—The number of minutes that a signing session stays alive without any activity.
signingsessiontimeoutmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signinguiversionstringNo—Reserved for Docusign.
signinguiversionmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signtimeformatstringNo—The format for the signature time. Valid values are: - none - HH:mm - h:mm - HH:mm:ss - h:mm:ss
signtimeformatmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
signtimeshowampmstringNo—When true, the time shows the AM or PM indicator.
signtimeshowampmmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
simplifiedsendingenabledstringNo—When true, simplified sending is enabled for the account. The default value is false.
simplifiedsendingenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
singlesignonenabledstringNo—When true, single sign-on (SSO) is enabled.
singlesignonenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
skipauthcompletedenvelopesstringNo—When true, do not require authentication prompt for viewing completed envelopes
skipauthcompletedenvelopesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
socialidrecipauthstringNo—When true, recipients can use social ids when signing
socialidrecipauthmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
specifydocumentvisibilitystringNo—When true, senders can specify the visibility of the documents in an envelope at the recipient level.
specifydocumentvisibilitymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
startinadvancedcorrectstringNo—When true, when initiating correction of an in-flight envelope the sender starts in advanced correct mode.
startinadvancedcorrectmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
supplementaldocumentsmustacceptstringNo—When true, account users must accept supplemental documents when signing.
supplementaldocumentsmustacceptmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
supplementaldocumentsmustreadstringNo—When true, account users must both view and accept supplemental documents when signing.
supplementaldocumentsmustreadmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
supplementaldocumentsmustviewstringNo—When true, account users must view supplemental documents when signing.
supplementaldocumentsmustviewmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
suppresscertificateenforcementstringNo—Boolean that specifies whether or not API calls require a x509 cert in the header of the call.
suppresscertificateenforcementmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
tabaccountsettingsjsonNo——
timezoneoffsetapistringNo—Specifies the time zone to use with the API. Valid values are: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
timezoneoffsetapimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
timezoneoffsetuistringNo—Specifies the time zone to use in the UI. Valid values are: - TZ_01_AfghanistanStandardTime - TZ_02_AlaskanStandardTime - TZ_03_ArabStandardTime - TZ_04_ArabianStandardTime - TZ_05_ArabicStandardTime - TZ_06_ArgentinaStandardTime - TZ_07_AtlanticStandardTime - TZ_08_AUS_CentralStandardTime - TZ_09_AUS_EasternStandardTime - TZ_10_AzerbaijanStandardTime - TZ_11_AzoresStandardTime - TZ_12_BangladeshStandardTime - TZ_13_CanadaCentralStandardTime - TZ_14_CapeVerdeStandardTime - TZ_15_CaucasusStandardTime - TZ_16_CentralAustraliaStandardTime - TZ_17_CentralAmericaStandardTime - TZ_18_CentralAsiaStandardTime - TZ_19_CentralBrazilianStandardTime - TZ_20_CentralEuropeStandardTime - TZ_21_CentralEuropeanStandardTime - TZ_22_CentralPacificStandardTime - TZ_23_CentralStandardTime - TZ_24_CentralStandardTimeMexico - TZ_25_ChinaStandardTime - TZ_26_DatelineStandardTime - TZ_27_E_AfricaStandardTime - TZ_28_E_AustraliaStandardTime - TZ_29_E_EuropeStandardTime - TZ_30_E_SouthAmericaStandardTime - TZ_31_EasternStandardTime - TZ_32_EgyptStandardTime - TZ_33_EkaterinburgStandardTime - TZ_34_FijiStandardTime - TZ_35_FLE_StandardTime - TZ_36_GeorgianStandardTime - TZ_37_GMT_StandardTime - TZ_38_GreenlandStandardTime - TZ_39_GreenwichStandardTime - TZ_40_GTB_StandardTime - TZ_41_HawaiianStandardTime - TZ_42_IndiaStandardTime - TZ_43_IranStandardTime - TZ_44_IsraelStandardTime - TZ_45_JordanStandardTime - TZ_46_KaliningradStandardTime - TZ_47_KamchatkaStandardTime - TZ_48_KoreaStandardTime - TZ_49_MagadanStandardTime - TZ_50_MauritiusStandardTime - TZ_51_MidAtlanticStandardTime - TZ_52_MiddleEastStandardTime - TZ_53_MontevideoStandardTime - TZ_54_MoroccoStandardTime - TZ_55_MountainStandardTime - TZ_56_MountainStandardTimeMMexico - TZ_57_MyanmarStandardTime - TZ_58_N_CentralAsiaStandardTime - TZ_59_NamibiaStandardTime - TZ_60_NepalStandardTime - TZ_61_NewZealandStandardTime - TZ_62_NewfoundlandStandardTime - TZ_63_NorthAsiaEastStandardTime - TZ_64_NorthAsiaStandardTime - TZ_65_PacificSAStandardTime - TZ_66_PacificStandardTime - TZ_67_PacificStandardTimeMexico - TZ_68_PakistanStandardTime - TZ_69_ParaguayStandardTime - TZ_70_RomanceStandardTime - TZ_71_RussianStandardTime - TZ_72_SAEasternStandardTime - TZ_73_SAPacificStandardTime - TZ_74_SAWesternStandardTime - TZ_75_SamoaStandardTime - TZ_76_SE_AsiaStandardTime - TZ_77_SingaporeStandardTime - TZ_78_SouthAfricaStandardTime - TZ_79_SriLankaStandardTime - TZ_80_SyriaStandardTime - TZ_81_TaipeiStandardTime - TZ_82_TasmaniaStandardTime - TZ_83_TokyoStandardTime - TZ_84_TongaStandardTime - TZ_85_TurkeyStandardTime - TZ_86_UlaanbaatarStandardTime - TZ_87_US_EasternStandardTime - TZ_88_USMountainStandardTime - TZ_89_VenezuelaStandardTime - TZ_90_VladivostokStandardTime - TZ_91_W_AustraliaStandardTime - TZ_92_W_CentralAfricaStandardTime - TZ_93_W_EuropeStandardTime - TZ_94_WestAsiaStandardTime - TZ_95_WestPacificStandardTime - TZ_96_YakutskStandardTime
timezoneoffsetuimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
universalsignatureoptinstringNo—Reserved for Docusign.
universalsignatureskipplatformsignaturestringNo——
universalsignatureskipplatformsignaturemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
useaccountlevelemailstringNo—Reserved for Docusign.
useaccountlevelemailmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
useconsumerdisclosurestringNo—When true, the account uses an Electronic Record and Signature Disclosure Statement. Note: Only Admin users can change this setting.
useconsumerdisclosuremetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
useconsumerdisclosurewithinaccountstringNo—When true, specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement.
useconsumerdisclosurewithinaccountmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usederivedkeysstringNo—Reserved for Docusign.
usederivedkeysmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usedocusignexpresssignercertificatestringNo—When true, signers are required to use Express Digital Signatures.
usedocusignexpresssignercertificatemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
useenvelopesearchmixedmodestringNo——
useenvelopesearchmixedmodemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usemultiappgroupsdatastringNo——
usemultiappgroupsdatametadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usenewblobforpdfstringNo—Reserved for Docusign.
usenewblobforpdfmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usenewenvelopesearchstringNo——
usenewenvelopesearchmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usenewenvelopesearchonlywhensearchingafterdatestringNo——
usenewenvelopesearchonlywhensearchingafterdatemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usenewenvelopesearchonlywithsearchtermstringNo——
usenewenvelopesearchonlywithsearchtermmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usesafesignercertificatesstringNo—When true, signers are required to use SAFE digital signatures.
usesafesignercertificatesmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usesapistringNo—When true, the account can use the API. Note: Only SysAdmin users can change this setting.
usesapimetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usesignatureproviderplatformstringNo—Boolean that specifies whether the account uses the digital signature provider platform to eSign.
usesignatureproviderplatformmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
usesmartcontractsv1stringNo——
validationsallowedstringNo—Boolean that specifies whether validations on recipient email domains are allowed.
validationsallowedmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
validationsbrandstringNo—Valid values are: - docusign - account
validationsbrandmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
validationscadencestringNo—Valid values are: - none - monthly
validationscadencemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
validationsenabledstringNo—When true, enables validations.
validationsenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
validationsreportstringNo—Valid values are: - none - life_sciences_part11
validationsreportmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
watermarkenabledstringNo—When true, the watermark feature is enabled for the account.
watermarkenabledmetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
writeremindertoenvelopehistorystringNo—When true, sent reminders are included in the envelope history.
writeremindertoenvelopehistorymetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
wurflminallowablescreensizestringNo—The smallest screen allowed.
wurflminallowablescreensizemetadatajsonNo—Metadata that indicates whether a property is editable and describes setting-specific options.
status_codeintegerNo—HTTP status code of the completed call
responsejsonNo—Parsed JSON response body
failure_reasonstringNo——
failure_typestringNo——
failed_atstringNo——
failed_stepstringNo——
failed_layerstringNo——
failed_at_statestringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—executeWaiting to call PUT /v2.1/accounts/{accountId}/settings
completedNoYesYes—HTTP call succeeded
failedNoYesNo—HTTP call failed

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompletedPerform PUT /v2.1/accounts/{accountId}/settings
* (any state)failfailedRecord the failure reason

API Usage ​

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

{
  "workflow_type": "docusign.accounts.put-settings",
  "initial_data": {
    "base_url": "value",
    "accountid": "value"
  }
}