Accounts: updateSettings

Updates the account settings for the specified account.

Request

HTTP request

PUT /v2.1/accounts/{accountId}/settings

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

Responses

CodeDescriptionReference
200

Successful response.

400

Error encountered.

errorDetails

SDK Method

Accounts::updateSettings

Definitions

accessCodeFormat

formatRequiredstring

formatRequiredMetadatasettingsMetadata

letterRequiredstring

letterRequiredMetadatasettingsMetadata

minimumLengthstring

minimumLengthMetadatasettingsMetadata

numberRequiredstring

numberRequiredMetadatasettingsMetadata

specialCharacterRequiredstring

specialCharacterRequiredMetadatasettingsMetadata

accountIdentityVerificationWorkflow

Specifies an identity verification workflow

defaultDescriptionstring

Text describing the purpose of the ID Verification workflow

defaultNamestring

Name of the ID Verification workflow

signatureProvideraccountSignatureProvider

Signature provider associated with the identity verification workflow

workflowIdstring

Workflow unique ID
This is the ID you must specify when setting ID Verification in an envelope

workflowResourceKeystring

Key for translated resources

accountNotification

expirationsexpirations

A complex element that specifies the expiration settings for the envelope.

remindersreminders

A complex element that specifies reminder settings for the envelope

userOverrideEnabledstring

accountSettingsInformation

Contains account settings information. Used in requests to set property values. Used in responses to report property values.

accessCodeFormataccessCodeFormat

accountDateTimeFormatstring

accountDateTimeFormatMetadatasettingsMetadata

Metadata that indicates whether the accountDateTimeFormat property is editable.

accountNamestring

The name of the account.

accountNameMetadatasettingsMetadata

Metadata that indicates whether the accountName property is editable.

accountNotificationaccountNotification

adoptSigConfigstring

If true, Signature Adoption Configuration is enabled.

adoptSigConfigMetadatasettingsMetadata

Metadata that indicates whether the adoptSigConfig property is editable.

advancedCorrectstring

If true, the Advanced Correction feature is enabled for this account.

advancedCorrectMetadatasettingsMetadata

Metadata that indicates whether the advancedCorrect property is editable.

allowAccessCodeFormatstring

allowAccessCodeFormatMetadatasettingsMetadata

Metadata that indicates whether the allowAccessCodeFormat property is editable.

allowAccountManagementGranularstring

allowAccountManagementGranularMetadatasettingsMetadata

Metadata that indicates whether the allowAccountManagementGranular property is editable.

allowAccountMemberNameChangestring

allowAccountMemberNameChangeMetadatasettingsMetadata

Metadata that indicates whether the allowAccountMemberNameChange property is editable.

allowAgentNameEmailEditstring

If true, an agent recipient can change the email addresses of recipients later in the signing order.

allowAgentNameEmailEditMetadatasettingsMetadata

Metadata that indicates whether the allowAgentNameEmailEdit property is editable.

allowAutoNavSettingsstring

If true, auto-navigation can be enabled for this account.

allowAutoNavSettingsMetadatasettingsMetadata

Metadata that indicates whether the allowAutoNavSettings property is editable.

allowBulkSendstring

If true, the account is able to bulk send.

allowBulkSendMetadatasettingsMetadata

Metadata that indicates whether the allowBulkSend property is editable.

allowCDWithdrawstring

Indicates whether the customer can withdraw their acceptance of the consumer disclosure.

allowCDWithdrawMetadatasettingsMetadata

Metadata that indicates whether the allowCDWithdraw property is editable.

allowConnectHttpListenerConfigsstring

allowConnectSendFinishLaterstring

If true, Connect will send FinishLater messages

allowConnectSendFinishLaterMetadatasettingsMetadata

Metadata that indicates whether the allowConnectSendFinishLater property is editable.

allowConsumerDisclosureOverridestring

If true, the account has the ability to change the Consumer Disclosure settin.

allowConsumerDisclosureOverrideMetadatasettingsMetadata

Metadata that indicates whether the allowConsumerDisclosureOverride property is editable.

allowDataDownloadstring

If true, senders can download form data from an envelope.

allowDataDownloadMetadatasettingsMetadata

Metadata that indicates whether the allowDataDownload property is editable.

allowDocumentDisclosuresstring

allowDocumentDisclosuresMetadatasettingsMetadata

Metadata that indicates whether the allowDocumentDisclosures property is editable.

allowDocumentsOnSignedEnvelopesstring

allowDocumentsOnSignedEnvelopesMetadatasettingsMetadata

Metadata that indicates whether the allowDocumentsOnSignedEnvelopes property is editable.

allowDocumentVisibilitystring

If true, administrators can change the document visiblity settings.

allowDocumentVisibilityMetadatasettingsMetadata

Metadata that indicates whether the allowDocumentVisibility property is editable.

allowEHankoStampsstring

If true, eHanko stamps are enabled.

allowEHankoStampsMetadatasettingsMetadata

Metadata that indicates whether the allowEHankoStamps property is editable.

allowENoteEOriginalstring

Specifies whether eNote eOriginal integration is enabled.

allowENoteEOriginalMetadatasettingsMetadata

Metadata that indicates whether the allowENoteEOriginal property is editable.

allowEnvelopeCorrectstring

Specifies whether the correction feature is enabled.

allowEnvelopeCorrectMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeCorrect property is editable.

allowEnvelopeCustodyTransferstring

Specifies whether the account is able to manage rules that transfer ownership of envelopes wthin the same account.

allowEnvelopeCustodyTransferMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeCustodyTransfer property is editable.

allowEnvelopeCustomFieldsstring

Specifies whether envelope custom fields are enabled.

allowEnvelopeCustomFieldsMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeCustomFields property is editable.

allowEnvelopePublishReportingstring

Specifies whether envelope publishing reporting is enabled.

allowEnvelopePublishReportingMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopePublishReporting property is editable.

allowEnvelopeReportingstring

Specifies whether the account has access to reports.

allowEnvelopeReportingMetadatasettingsMetadata

Metadata that indicates whether the allowEnvelopeReporting property is editable.

allowExpressionstring

If the account plan does not include calculated fields, this setting allows an account to use them.

allowExpressionMetadatasettingsMetadata

Metadata that indicates whether the allowExpression property is editable.

allowExpressSignerCertificatestring

Specifies whether signers are required to use Express Digital Signatures.

allowExpressSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowExpressSignerCertificate property is editable.

allowExtendedSendingResourceFilestring

allowExtendedSendingResourceFileMetadatasettingsMetadata

Metadata that indicates whether the allowExtendedSendingResourceFile property is editable.

allowExternalSignaturePadstring

Specifies whether the account can configure and use signature pads for their recipients.

allowExternalSignaturePadMetadatasettingsMetadata

Metadata that indicates whether the allowExternalSignaturePad property is editable.

allowInPersonstring

Specifies whether the account administrator can enable in person signing.

allowInPersonMetadatasettingsMetadata

Metadata that indicates whether the allowInPerson property is editable.

allowManagedStampsstring

allowManagedStampsMetadatasettingsMetadata

Metadata that indicates whether the allowManagedStamps property is editable.

allowMarkupstring

When true, Document Markup is enabled for envelope. The account must have Document Markup enabled to use this.

allowMarkupMetadatasettingsMetadata

Metadata that indicates whether the allowMarkup property is editable.

allowMemberTimeZonestring

Specifies whether users can set their own time zone settings.

allowMemberTimeZoneMetadatasettingsMetadata

Metadata that indicates whether the allowMemberTimeZone property is editable.

allowMergeFieldsstring

Specified whether merge fields are enabled for the account.

allowMergeFieldsMetadatasettingsMetadata

Metadata that indicates whether the allowMergeFields property is editable.

allowMultipleBrandProfilesstring

Specifies whether the account supports multiple brands.

allowMultipleBrandProfilesMetadatasettingsMetadata

Metadata that indicates whether the allowMultipleBrandProfiles property is editable.

allowMultipleSignerAttachmentsstring

Specifies whether recipients are able to upload multiple signer attachments with a single attachment.

allowMultipleSignerAttachmentsMetadatasettingsMetadata

Metadata that indicates whether the allowMultipleSignerAttachments property is editable.

allowNonUSPhoneAuthstring

Specifies whether users can use international numbers for phone authentication.

allowNonUSPhoneAuthMetadatasettingsMetadata

Metadata that indicates whether the allowNonUSPhoneAuth property is editable.

allowOfflineSigningstring

Specifies whether offline signing is enabled for the account.

allowOfflineSigningMetadatasettingsMetadata

Metadata that indicates whether the allowOfflineSigning property is editable.

allowOpenTrustSignerCertificatestring

allowOpenTrustSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowOpenTrustSignerCertificate property is editable.

allowOrganizationsstring

allowOrganizationsMetadatasettingsMetadata

Metadata that indicates whether the allowOrganizations property is editable.

allowPaymentProcessingstring

allowPaymentProcessingMetadatasettingsMetadata

Metadata that indicates whether the allowPaymentProcessing property is editable.

allowPersonalSignerCertificatestring

allowPersonalSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowPersonalSignerCertificate property is editable.

allowPhoneAuthenticationstring

allowPhoneAuthenticationMetadatasettingsMetadata

Metadata that indicates whether the allowPhoneAuthentication property is editable.

allowPhoneAuthOverridestring

allowPhoneAuthOverrideMetadatasettingsMetadata

Metadata that indicates whether the allowPhoneAuthOverride property is editable.

allowPrivateSigningGroupsstring

allowPrivateSigningGroupsMetadatasettingsMetadata

Metadata that indicates whether the allowPrivateSigningGroups property is editable.

allowRemindersstring

If true, allows an account administrator to turn on reminders and expiration defaults for the account.

allowRemindersMetadatasettingsMetadata

Metadata that indicates whether the allowReminders property is editable.

allowResourceFileBrandingstring

If true, resource files can be uploaded in branding.

allowResourceFileBrandingMetadatasettingsMetadata

Metadata that indicates whether the allowResourceFileBranding property is editable.

allowSafeBioPharmaSignerCertificatestring

If true, allows the account administrator to specify that signers are required to use SAFE digital signatures.

allowSafeBioPharmaSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the allowSafeBioPharmaSignerCertificate property is editable.

allowSecurityAppliancestring

allowSecurityApplianceMetadatasettingsMetadata

Metadata that indicates whether the allowSecurityAppliance property is editable.

allowSendToCertifiedDeliverystring

If true, the account admin can enable the Send to Certified Delivery feature on the account.

allowSendToCertifiedDeliveryMetadatasettingsMetadata

Metadata that indicates whether the allowSendToCertifiedDelivery property is editable.

allowSendToIntermediarystring

If true, the account admin can enable the Send to Intermediary feature on the account.

allowSendToIntermediaryMetadatasettingsMetadata

Metadata that indicates whether the allowSendToIntermediary property is editable.

allowServerTemplatesstring

If true, the account can use templates.

allowServerTemplatesMetadatasettingsMetadata

Metadata that indicates whether the allowServerTemplates property is editable.

allowSharedTabsstring

If true, the account can use shared tabs.

allowSharedTabsMetadatasettingsMetadata

Metadata that indicates whether the allowSharedTabs property is editable.

allowSignatureStampsstring

allowSignatureStampsMetadatasettingsMetadata

Metadata that indicates whether the allowSignatureStamps property is editable.

allowSignDocumentFromHomePagestring

allowSignDocumentFromHomePageMetadatasettingsMetadata

Metadata that indicates whether the allowSignDocumentFromHomePage property is editable.

allowSignerReassignstring

Account setting that determines whether the recipient of an envelope sent from this account can reassign it to another person.

allowSignerReassignMetadatasettingsMetadata

Metadata that indicates whether the allowSignerReassign property is editable.

allowSignerReassignOverridestring

allowSignerReassignOverrideMetadatasettingsMetadata

Metadata that indicates whether the allowSignerReassignOverride property is editable.

allowSigningExtensionsstring

allowSigningExtensionsMetadatasettingsMetadata

Metadata that indicates whether the allowSigningExtensions property is editable.

allowSigningGroupsstring

allowSigningGroupsMetadatasettingsMetadata

Metadata that indicates whether the allowSigningGroups property is editable.

allowSigningRadioDeselectstring

allowSigningRadioDeselectMetadatasettingsMetadata

Metadata that indicates whether the allowSigningRadioDeselect property is editable.

allowSignNowstring

If true, the account administrator can enable the Sign Now feature.

allowSignNowMetadatastring

Metadata that indicates whether the allowSignNow property is editable.

allowSocialIdLoginstring

If true, the account administrator can enable social id login for the account.

allowSocialIdLoginMetadatasettingsMetadata

Metadata that indicates whether the allowSocialIdLogin property is editable.

allowSupplementalDocumentsstring

When true, this user can use the supplemental documents feature.

allowSupplementalDocumentsMetadatasettingsMetadata

Metadata for allowSupplementalDocuments.

anchorPopulationScopestring

Valid values are:

  • document
  • envelope

anchorPopulationScopeMetadatasettingsMetadata

Metadata that indicates whether the anchorPopulationScope property is editable.

anchorTagVersionedPlacementEnabledstring

Valid values are:

  • system_default
  • off
  • on

anchorTagVersionedPlacementMetadataEnabledsettingsMetadata

attachCompletedEnvelopestring

attachCompletedEnvelopeMetadatasettingsMetadata

Metadata that indicates whether the attachCompletedEnvelope property is editable.

authenticationCheckstring

Specifies how often to check authentication. Valid values are:

  • initial_access
  • each_access

authenticationCheckMetadatasettingsMetadata

Metadata that indicates whether the authenticationCheck property is editable.

autoNavRulestring

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

autoNavRuleMetadatasettingsMetadata

Metadata that indicates whether the autoNavRule property is editable.

autoProvisionSignerAccountstring

autoProvisionSignerAccountMetadatasettingsMetadata

Metadata that indicates whether the autoProvisionSignerAccount property is editable.

bccEmailArchivestring

bccEmailArchiveMetadatasettingsMetadata

Metadata that indicates whether the bccEmailArchive property is editable.

betaSwitchConfigurationstring

Reserved for DocuSign.

betaSwitchConfigurationMetadatasettingsMetadata

Metadata that indicates whether the betaSwitchConfiguration property is editable.

billingAddressaddressInformation

The billing address for the account.

billingAddressMetadatasettingsMetadata

Metadata that indicates whether the billingAddress property is editable.

bulkSendstring

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

bulkSendMetadatasettingsMetadata

Metadata that indicates whether the bulkSend property is editable.

canSelfBrandSendstring

canSelfBrandSendMetadatasettingsMetadata

Metadata that indicates whether the canSelfBrandSend property is editable.

canSelfBrandSignstring

canSelfBrandSignMetadatasettingsMetadata

Metadata that indicates whether the canSelfBrandSign property is editable.

captureVoiceRecordingstring

captureVoiceRecordingMetadatasettingsMetadata

Metadata that indicates whether the captureVoiceRecording property is editable.

cfrUseWideImagestring

cfrUseWideImageMetadatasettingsMetadata

Metadata that indicates whether the cfrUseWideImage property is editable.

chromeSignatureEnabledstring

chromeSignatureEnabledMetadatasettingsMetadata

Metadata that indicates whether the chromeSignatureEnabled property is editable.

commentEmailShowMessageTextstring

commentEmailShowMessageTextMetadatasettingsMetadata

Metadata that indicates whether the commentEmailShowMessageText property is editable.

commentsAllowEnvelopeOverridestring

commentsAllowEnvelopeOverrideMetadatasettingsMetadata

Metadata that indicates whether the commentsAllowEnvelopeOverride property is editable.

conditionalFieldsEnabledstring

conditionalFieldsEnabledMetadatasettingsMetadata

Metadata that indicates whether the conditionalFieldsEnabled property is editable.

consumerDisclosureFrequencystring

Speficies how often to display the consumer disclosure. Valid values are:

  • once
  • always
  • each_access

consumerDisclosureFrequencyMetadatasettingsMetadata

Metadata that indicates whether the consumerDisclosureFrequency property is editable.

convertPdfFieldsstring

convertPdfFieldsMetadatasettingsMetadata

Metadata that indicates whether the convertPdfFields property is editable.

dataPopulationScopestring

Valid values are:

  • document
  • envelope

dataPopulationScopeMetadatasettingsMetadata

Metadata that indicates whether the dataPopulationScope property is editable.

disableMobileAppstring

When true, the mobile app distributor key is prevented from connecting for account users.

disableMobileAppMetadatasettingsMetadata

Metadata that indicates whether the disableMobileApp property is editable.

disableMobilePushNotificationsstring

When true, push notifications are disabled for the account.

disableMobilePushNotificationsMetadatasettingsMetadata

Metadata that indicates whether the disableMobilePushNotifications property is editable.

disableMobileSendingstring

When true, sending from a mobile application is disabled.

disableMobileSendingMetadatasettingsMetadata

Metadata that indicates whether the disableMobileSending property is editable.

disableMultipleSessionsstring

When true, account users cannot be logged into multiple sessions at the same time.

disableMultipleSessionsMetadatasettingsMetadata

Metadata that indicates whether the disableMultipleSessions property is editable.

disablePurgeNotificationsForSenderMetadatasettingsMetadata

Metadata that indicates whether the disablePurgeNotificationsForSender property is editable.

disableSignerCertViewstring

When true, signers cannot view certificates of completion.

disableSignerCertViewMetadatasettingsMetadata

Metadata that indicates whether the disableSignerCertView property is editable.

disableSignerHistoryViewstring

When true, signers cannot view envelope history.

disableSignerHistoryViewMetadatasettingsMetadata

Metadata that indicates whether the disableSignerHistoryView property is editable.

disableStyleSignaturestring

When true, the Select Style option is hidden from signers and they must draw their signature instead.

disableStyleSignatureMetadatasettingsMetadata

Metadata that indicates whether the disableStyleSignature property is editable.

disableUploadSignaturestring

When true, signers cannot upload custom image files of their signature and initials.

disableUploadSignatureMetadatasettingsMetadata

Metadata that indicates whether the disableUploadSignature property is editable.

disableUserSharingstring

When true, the User Sharing feature is disabled for the account.

disableUserSharingMetadatasettingsMetadata

Metadata that indicates whether the disableUserSharing property is editable.

displayBetaSwitchstring

displayBetaSwitchMetadatasettingsMetadata

Metadata that indicates whether the displayBetaSwitch property is editable.

documentConversionRestrictionsstring

Valid values are:

  • no_restrictions
  • allow_pdf_only
  • no_upload

documentConversionRestrictionsMetadatasettingsMetadata

Metadata that indicates whether the documentConversionRestrictions property is editable.

documentRetentionstring

documentRetentionMetadatasettingsMetadata

Metadata that indicates whether the documentRetention property is editable.

documentRetentionPurgeTabsstring

documentVisibilitystring

Valid values are:

  • Off
  • MustSignToViewUnlessSenderAccount
  • MustSignToViewUnlessSender
  • SenderCanSetMustSignToViewUnlessSenderAccount
  • SenderCanSetMustSignToViewUnlessSender

documentVisibilityMetadatasettingsMetadata

Metadata that indicates whether the documentVisibility property is editable.

emailTemplateVersionstring

emailTemplateVersionMetadatasettingsMetadata

Metadata that indicates whether the emailTemplateVersion property is editable.

enableAccessCodeGeneratorstring

When true, enables Access Code Generator on the account.

enableAccessCodeGeneratorMetadatasettingsMetadata

Metadata that indicates whether the enableAccessCodeGenerator property is editable.

enableAdvancedPaymentsstring

When true, enables Advanced Payments for the account.

enableAdvancedPaymentsMetadatasettingsMetadata

Metadata that indicates whether the enableAdvancedPayments property is editable.

enableAdvancedPowerFormsstring

When true, enables advanced PowerForms for the account.

enableAdvancedPowerFormsMetadatasettingsMetadata

Metadata that indicates whether the enableAdvancedPowerForms property is editable.

enableAutoNavstring

When true, enables the account to set the AutoNav rule setting, which allows a sender to override the auto navigation setting per envelope.

enableAutoNavMetadatasettingsMetadata

Metadata that indicates whether the enableAutoNav property is editable.

enableCalculatedFieldsstring

When true, the account is enabled to use calculated fields (must be allowed at the account level for this setting to be changeable).

enableCalculatedFieldsMetadatasettingsMetadata

Metadata that indicates whether the enableCalculatedFields property is editable.

enableClickwrapsstring

enableClickwrapsMetadatasettingsMetadata

Metadata that indicates whether the enableClickwraps property is editable.

enableCustomerSatisfactionMetricTrackingstring

When true, enables customer satisfaction metric tracking for the account.

enableCustomerSatisfactionMetricTrackingMetadatasettingsMetadata

Metadata that indicates whether the enableCustomerSatisfactionMetricTracking property is editable.

enableDSProstring

Reserved for DocuSign.

enableDSProMetadatasettingsMetadata

Metadata that indicates whether the enableDSPro property is editable.

enableEnvelopeStampingByAccountAdminstring

When true, enables the account administrator to control envelope stamping for an account (placement of the EnvelopeID).

enableEnvelopeStampingByAccountAdminMetadatasettingsMetadata

Metadata that indicates whether the enableEnvelopeStampingByAccountAdmin property is editable.

enableEnvelopeStampingByDSAdminstring

When true, enables the DocuSign administrator to control envelope stamping for an account (placement of the EnvelopeID).

enableEnvelopeStampingByDSAdminMetadatasettingsMetadata

Metadata that indicates whether the enableEnvelopeStampingByDSAdmin property is editable.

enablePaymentProcessingstring

When true, enables payment processing for this account.

enablePaymentProcessingMetadatasettingsMetadata

Metadata that indicates whether the enablePaymentProcessing property is editable.

enablePowerFormstring

When true, enables PowerForms for an account.

enablePowerFormDirectstring

When true, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms.

enablePowerFormDirectMetadatasettingsMetadata

Metadata that indicates whether the enablePowerFormDirect property is editable.

enablePowerFormMetadatasettingsMetadata

Metadata that indicates whether the enablePowerForm property is editable.

enableRecipientDomainValidationstring

Reserved for DocuSign.

enableRecipientDomainValidationMetadatasettingsMetadata

Metadata that indicates whether the enableRecipientDomainValidation property is editable.

enableReportLinksstring

Enables direct links to envelopes in reports for administrators in the following scopes:

  • NoEnvelopes
  • AllEnvelopes
  • OnlyOwnEnvelopes

enableReportLinksMetadatasettingsMetadata

Metadata that indicates whether the enableReportLinks property is editable.

enableRequireSignOnPaperstring

When true, the account can use the requireSignOnPaper option.

enableRequireSignOnPaperMetadatasettingsMetadata

Metadata that indicates whether the enableRequireSignOnPaper property is editable.

enableReservedDomainstring

When true, enables reserved domains for an account. This is configured by the account administrators on a page which they can specify reserved domain and reserved users in their domain. This allows them to lock down email address domains to exist only in their account and in no other location in DocuSign.

enableReservedDomainMetadatasettingsMetadata

Metadata that indicates whether the enableReservedDomain property is editable.

enableResponsiveSigningstring

When true, enables responsive signing.

enableResponsiveSigningMetadatasettingsMetadata

Metadata that indicates whether the enableResponsiveSigning property is editable.

enableScheduledReleasestring

enableScheduledReleaseMetadatasettingsMetadata

Metadata that indicates whether the enableScheduledRelease property is editable.

enableSendingTagsFontSettingsstring

When true, enables fonts to be set on tags.

enableSendingTagsFontSettingsMetadatasettingsMetadata

Metadata that indicates whether the enableSendingTagsFontSettings property is editable.

enableSendToAgentstring

When true, this account can use the agent recipient type.

enableSendToAgentMetadatasettingsMetadata

Metadata that indicates whether the enableSendToAgent property is editable.

enableSendToIntermediarystring

When true, this account can use the intermediary recipient type.

enableSendToIntermediaryMetadatasettingsMetadata

Metadata that indicates whether the enableSendToIntermediary property is editable.

enableSendToManagestring

When true, this account can use the editor recipient type.

enableSendToManageMetadatasettingsMetadata

Metadata that indicates whether the enableSendToManage property is editable.

enableSequentialSigningAPIstring

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

enableSequentialSigningAPIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningAPI property is editable.

enableSequentialSigningUIstring

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

enableSequentialSigningUIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningUI property is editable.

enableSignerAttachmentsstring

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

enableSignerAttachmentsMetadatasettingsMetadata

Metadata that indicates whether the enableSignerAttachments property is editable.

enableSigningExtensionCommentsstring

When true, enables commenting functionality.

enableSigningExtensionCommentsMetadatasettingsMetadata

Metadata that indicates whether the enableSigningExtensionComments property is editable.

enableSigningExtensionConversationsstring

When true, enables conversation functionality.

enableSigningExtensionConversationsMetadatasettingsMetadata

Metadata that indicates whether the enableSigningExtensionConversations property is editable.

enableSigningOrderSettingsForAccountstring

When true, switches Signing Order to On by default for new envelopes.

enableSigningOrderSettingsForAccountMetadatasettingsMetadata

Metadata that indicates whether the enableSigningOrderSettingsForAccount property is editable.

enableSignOnPaperstring

When true, a sender can allow signers to use the sign on paper option.

enableSignOnPaperMetadatasettingsMetadata

Metadata that indicates whether the enableSignOnPaper property is editable.

enableSignOnPaperOverridestring

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

enableSignOnPaperOverrideMetadatasettingsMetadata

Metadata that indicates whether the enableSignOnPaperOverride property is editable.

enableSignWithNotarystring

When set to true, Sign with Notary functionality is enabled on the envelope.

enableSignWithNotaryMetadatasettingsMetadata

Metadata that indicates whether the enableSignWithNotary property is editable.

enableSMSAuthenticationstring

When true, the account can use SMS authentication.

enableSMSAuthenticationMetadatasettingsMetadata

Metadata that indicates whether the enableSMSAuthentication property is editable.

enableSocialIdLoginstring

When true, enables the ability to use social IDs to login to an account.

enableSocialIdLoginMetadatasettingsMetadata

Metadata that indicates whether the enableSocialIdLogin property is editable.

enableStrikeThroughstring

When true, enables strikethrough formatting in documents.

enableStrikeThroughMetadatasettingsMetadata

Metadata that indicates whether the enableStrikeThrough property is editable.

enableTransactionPointstring

Reserved for DocuSign.

enableTransactionPointMetadatasettingsMetadata

Metadata that indicates whether the enableTransactionPoint property is editable.

enableVaultingstring

When true, Vaulting is enabled for the account.

enableVaultingMetadatasettingsMetadata

Metadata that indicates whether the enableVaulting property is editable.

enableWitnessingstring

When true, enables documents to be signed by a witness.

enableWitnessingMetadatasettingsMetadata

Metadata that indicates whether the enableWitnessing property is editable.

enforceTemplateNameUniquenessstring

When true, the template name must be unique.

enforceTemplateNameUniquenessMetadatasettingsMetadata

Metadata that indicates whether the enforceTemplateNameUniqueness property is editable.

envelopeIntegrationAllowedstring

When true, allows custom admins to enable Connect for their accounts.

envelopeIntegrationAllowedMetadatasettingsMetadata

Metadata that indicates whether the envelopeIntegrationAllowed property is editable.

envelopeIntegrationEnabledstring

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.

envelopeIntegrationEnabledMetadatasettingsMetadata

Metadata that indicates whether the envelopeIntegrationEnabled property is editable.

envelopeStampingDefaultValuestring

envelopeStampingDefaultValueMetadatasettingsMetadata

Metadata that indicates whether the envelopeStampingDefaultValue property is editable.

expressSendstring

expressSendAllowTabsstring

expressSendAllowTabsMetadatasettingsMetadata

Metadata that indicates whether the expressSendAllowTabs property is editable.

expressSendMetadatasettingsMetadata

Metadata that indicates whether the expressSend property is editable.

externalDocumentSourcesexternalDocumentSources

externalSignaturePadTypestring

Specifies the signature pad type. Valid values are:

  • none
  • topaz
  • e_padv9
  • e_pad_integrisign
  • topaz_sigplusextlite

externalSignaturePadTypeMetadatasettingsMetadata

Metadata that indicates whether the externalSignaturePadType property is editable.

faxOutEnabledstring

faxOutEnabledMetadatasettingsMetadata

Metadata that indicates whether the faxOutEnabled property is editable.

hideAccountAddressInCoCstring

hideAccountAddressInCoCMetadatasettingsMetadata

Metadata that indicates whether the hideAccountAddressInCoC property is editable.

hidePricingstring

hidePricingMetadatasettingsMetadata

Metadata that indicates whether the hidePricing property is editable.

idCheckConfigurations[idCheckConfiguration]

idCheckExpirestring

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.

idCheckExpireDaysstring

The number of days before user authentication credentials expire. A value of 0 specifies that users must re-authenticate for each new session.

idCheckExpireDaysMetadatasettingsMetadata

Metadata that indicates whether the idCheckExpireDays property is editable.

idCheckExpireMetadatasettingsMetadata

Metadata that indicates whether the idCheckExpire property is editable.

idCheckExpireMinutesstring

The number of minutes before user authentication credentials expire.

idCheckExpireMinutesMetadatasettingsMetadata

Metadata that indicates whether the idCheckExpireMinutes property is editable.

idCheckRequiredstring

Determines how 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.

idCheckRequiredMetadatasettingsMetadata

Metadata that indicates whether the idCheckRequired property is editable.

identityVerification[accountIdentityVerificationWorkflow]

identityVerificationMetadatasettingsMetadata

Metadata that indicates whether the identityVerification property is editable.

ignoreErrorIfAnchorTabNotFoundstring

Reserved for DocuSign.

ignoreErrorIfAnchorTabNotFoundMetadataEnabledsettingsMetadata

Reserved for DocuSign.

inPersonIDCheckQuestionstring

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.

inPersonIDCheckQuestionMetadatasettingsMetadata

Metadata that indicates whether the inPersonIDCheckQuestion property is editable.

inPersonSigningEnabledstring

When true, in-person signing is enabled for the account.

inPersonSigningEnabledMetadatasettingsMetadata

Metadata that indicates whether the inPersonSigningEnabled property is editable.

inSessionEnabledstring

When true, the account can send in-session (embedded) envelopes.

inSessionEnabledMetadatasettingsMetadata

Metadata that indicates whether the inSessionEnabled property is editable.

inSessionSuppressEmailsstring

When true, emails cannot be sent to the in-session (embedded) recipients on an envelope.

inSessionSuppressEmailsMetadatasettingsMetadata

Metadata that indicates whether the inSessionSuppressEmails property is editable.

maximumSigningGroupsstring

The maximum number of signing groups allowed for the account.

maximumSigningGroupsMetadatasettingsMetadata

Metadata that indicates whether the maximumSigningGroups property is editable.

maximumUsersPerSigningGroupstring

The maximum number of users per signing group.

maximumUsersPerSigningGroupMetadatasettingsMetadata

Metadata that indicates whether the maximumUsersPerSigningGroup property is editable.

maxNumberOfCustomStampsstring

The maximum number of custom stamps.

mobileSessionTimeoutstring

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.

mobileSessionTimeoutMetadatasettingsMetadata

Metadata that indicates whether the mobileSessionTimeout property is editable.

numberOfActiveCustomStampsstring

optInMobileSigningV02string

optInMobileSigningV02MetadatasettingsMetadata

Metadata that indicates whether the optInMobileSigningV02 property is editable.

optOutAutoNavTextAndTabColorUpdatesstring

optOutAutoNavTextAndTabColorUpdatesMetadatasettingsMetadata

Metadata that indicates whether the optOutAutoNavTextAndTabColorUpdates property is editable.

optOutNewPlatformSealstring

optOutNewPlatformSealPlatformMetadatasettingsMetadata

Metadata that indicates whether the optOutNewPlatformSealPlatform property is editable.

phoneAuthRecipientMayProvidePhoneNumberstring

phoneAuthRecipientMayProvidePhoneNumberMetadatasettingsMetadata

Metadata that indicates whether the phoneAuthRecipientMayProvidePhoneNumber property is editable.

pkiSignDownloadedPDFDocsstring

Always true. Specifies that PDF files downloaded from the platform are signed.

pkiSignDownloadedPDFDocsMetadatasettingsMetadata

Metadata that indicates whether the pkiSignDownloadedPDFDocs property is editable.

recipientsCanSignOfflinestring

If true, recipients recieving envelopes from this account can sign offline.

recipientsCanSignOfflineMetadatasettingsMetadata

Metadata that indicates whether the recipientsCanSignOffline property is editable.

recipientSigningAutoNavigationControlstring

recipientSigningAutoNavigationControlMetadatasettingsMetadata

Metadata that indicates whether the recipientSigningAutoNavigationControl property is editable.

require21CFRpt11Compliancestring

If true, recipients are required to use a 21 CFR part 11-compliant signing experience.

require21CFRpt11ComplianceMetadatasettingsMetadata

Metadata that indicates whether the require21CFRpt11Compliance property is editable.

requireDeclineReasonstring

If true, requires signers who decline to sign an envelope sent from this account to provide a reason for declining.

requireDeclineReasonMetadatasettingsMetadata

Metadata that indicates whether the requireDeclineReason property is editable.

requireExternalUserManagementstring

requireExternalUserManagementMetadatasettingsMetadata

Metadata that indicates whether the requireExternalUserManagement property is editable.

requireSignerCertificateTypestring

Valid values are:

  • none
  • docusign_express
  • docusign_personal
  • safe
  • open_trust

requireSignerCertificateTypeMetadatasettingsMetadata

Metadata that indicates whether the requireSignerCertificateType property is editable.

rsaVeridAccountNamestring

The RSA account name.

Note: Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

rsaVeridPasswordstring

The password used with the RSA account.

Note: Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

rsaVeridRulesetstring

The RSA rule set used with the account.

Note: Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

rsaVeridUserIdstring

The user ID for the RSA account.

Note: Modifying this value may disrupt your ID Check capability. Ensure you have the correct value before changing it.

selfSignedRecipientEmailDocumentstring

Valid values are:

  • include_pdf
  • include_link

selfSignedRecipientEmailDocumentMetadatasettingsMetadata

Metadata that indicates whether the selfSignedRecipientEmailDocument property is editable.

selfSignedRecipientEmailDocumentUserOverridestring

When true the selfSignedRecipientEmailDocument user setting can be set for an individual user. The user setting overrides the account setting.

selfSignedRecipientEmailDocumentUserOverrideMetadatasettingsMetadata

Metadata that indicates whether the selfSignedRecipientEmailDocumentUserOverride property is editable.

senderCanSignInEachLocationstring

senderCanSignInEachLocationMetadatasettingsMetadata

Metadata that indicates whether the senderCanSignInEachLocation property is editable.

senderMustAuthenticateSigningstring

When true, a sender who is also a recipient of an envelope must follow the authentication requirements for the envelope.

senderMustAuthenticateSigningMetadatasettingsMetadata

Metadata that indicates whether the senderMustAuthenticateSigning property is editable.

sendingTagsFontColorstring

sendingTagsFontColorMetadatasettingsMetadata

Metadata that indicates whether the sendingTagsFontColor property is editable.

sendingTagsFontNamestring

sendingTagsFontNameMetadatasettingsMetadata

Metadata that indicates whether the sendingTagsFontName property is editable.

sendingTagsFontSizestring

sendingTagsFontSizeMetadatasettingsMetadata

Metadata that indicates whether the sendingTagsFontSize property is editable.

sendToCertifiedDeliveryEnabledstring

When true, the account can use the certified deliveries recipient type.

sendToCertifiedDeliveryEnabledMetadatasettingsMetadata

Metadata that indicates whether the sendToCertifiedDeliveryEnabled property is editable.

sessionTimeoutstring

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.

sessionTimeoutMetadatasettingsMetadata

Metadata that indicates whether the sessionTimeout property is editable.

setRecipEmailLangstring

setRecipEmailLangMetadatasettingsMetadata

Metadata that indicates whether the setRecipEmailLang property is editable.

setRecipSignLangstring

If true, setting a unique language for a recipient not only affects the email language, but also the signing language they are presented with. If false, only the email will be affected by the sender specifying a unique language for a recipient

setRecipSignLangMetadatasettingsMetadata

Metadata that indicates whether the setRecipSignLang property is editable.

sharedTemplateFoldersstring

sharedTemplateFoldersMetadatasettingsMetadata

Metadata that indicates whether the sharedTemplateFolders property is editable.

showCompleteDialogInEmbeddedSessionstring

showCompleteDialogInEmbeddedSessionMetadatasettingsMetadata

Metadata that indicates whether the showCompleteDialogInEmbeddedSession property is editable.

showInitialConditionalFieldsstring

showInitialConditionalFieldsMetadatasettingsMetadata

Metadata that indicates whether the showInitialConditionalFields property is editable.

showLocalizedWatermarksstring

showLocalizedWatermarksMetadatasettingsMetadata

Metadata that indicates whether the showLocalizedWatermarks property is editable.

showTutorialsstring

If true, show tutorials.

showTutorialsMetadatasettingsMetadata

Metadata that indicates whether the showTutorials property is editable.

signatureProviders[array]

signatureProvidersMetadatasettingsMetadata

Metadata that indicates whether the signatureProviders property is editable.

signDateFormatstring

The format for the signature date. Valid values are:

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

signDateFormatMetadatasettingsMetadata

Metadata that indicates whether the signDateFormat property is editable.

signerAttachCertificateToEnvelopePDFstring

If true, the certificate of completion is included in the envelope documents PDF when it is downloaded.

signerAttachCertificateToEnvelopePDFMetadatasettingsMetadata

Metadata that indicates whether the signerAttachCertificateToEnvelopePDF property is editable.

signerAttachConcatstring

If 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.

signerAttachConcatMetadatasettingsMetadata

Metadata that indicates whether the signerAttachConcat property is editable.

signerCanCreateAccountstring

If true, the signer can create a DocuSign account after signing.

signerCanCreateAccountMetadatasettingsMetadata

Metadata that indicates whether the signerCanCreateAccount property is editable.

signerCanSignOnMobilestring

When set to true, the recipient can sign on a mobile device.

signerCanSignOnMobileMetadatasettingsMetadata

Metadata that indicates whether the signerCanSignOnMobile property is editable.

signerInSessionUseEnvelopeCompleteEmailstring

If true, send only a completed email to an in-session signer and only if in-session emails are not supressed.

signerInSessionUseEnvelopeCompleteEmailMetadatasettingsMetadata

Metadata that indicates whether the signerInSessionUseEnvelopeCompleteEmail property is editable.

signerLoginRequirementsstring

Speficies whether a signer has to log in. Valid values are:

  • login_not_required
  • login_required_if_account_holder
  • login_required_per_session
  • login_required_per_envelope

signerLoginRequirementsMetadatasettingsMetadata

Metadata that indicates whether the signerLoginRequirements property is editable.

signerMustHaveAccountstring

When true, senders can only send an envelope to a recipient that has a DocuSign account.

signerMustHaveAccountMetadatasettingsMetadata

Metadata that indicates whether the signerMustHaveAccount property is editable.

signerMustLoginToSignstring

When true, signers must log in to the DocuSign platform to sign an envelope.

signerMustLoginToSignMetadatasettingsMetadata

Metadata that indicates whether the signerMustLoginToSign property is editable.

signerShowSecureFieldInitialValuesstring

When true, the initial value of all SecureFields is written to the document when sent.

signerShowSecureFieldInitialValuesMetadatasettingsMetadata

Metadata that indicates whether the signerShowSecureFieldInitialValues property is editable.

signingSessionTimeoutstring

The number of minutes that a signing session stays alive without any activity.

signingSessionTimeoutMetadatasettingsMetadata

Metadata that indicates whether the signingSessionTimeout property is editable.

signingUiVersionstring

Reserved for DocuSign.

signingUiVersionMetadatasettingsMetadata

Metadata that indicates whether the signingUiVersion property is editable.

signTimeFormatstring

The format for the signature time. Valid values are:

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

signTimeFormatMetadatasettingsMetadata

Metadata that indicates whether the signTimeFormat property is editable.

signTimeShowAmPmstring

If true, the time shows the AM or PM indicator.

signTimeShowAmPmMetadatasettingsMetadata

Metadata that indicates whether the signTimeShowAmPm property is editable.

simplifiedSendingEnabledstring

simplifiedSendingEnabledMetadatasettingsMetadata

Metadata that indicates whether the simplifiedSendingEnabled property is editable.

singleSignOnEnabledstring

If true, single sign-on (SSO) is enabled.

singleSignOnEnabledMetadatasettingsMetadata

Metadata that indicates whether the singleSignOnEnabled property is editable.

skipAuthCompletedEnvelopesstring

If true, do not require authentication prompt for viewing completed envelopes

skipAuthCompletedEnvelopesMetadatasettingsMetadata

Metadata that indicates whether the skipAuthCompletedEnvelopes property is editable.

socialIdRecipAuthstring

If true, recipients can use social ids when signing

socialIdRecipAuthMetadatasettingsMetadata

Metadata that indicates whether the socialIdRecipAuth property is editable.

specifyDocumentVisibilitystring

If true, a sender can specify the document visibility for an envelope. This makes the doc specific grid available, which allows a sender to override visibility on a per document level.

specifyDocumentVisibilityMetadatasettingsMetadata

Metadata that indicates whether the specifyDocumentVisibility property is editable.

startInAdvancedCorrectstring

If true, when initiating correction of an in-flight envelope the sender starts in advanced correct mode.

startInAdvancedCorrectMetadatasettingsMetadata

Metadata that indicates whether the startInAdvancedCorrect property is editable.

supplementalDocumentsMustAcceptstring

When true, this user must accept supplemental documents.

supplementalDocumentsMustAcceptMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustAccept property is editable.

supplementalDocumentsMustReadstring

When true, this user must read supplemental documents.

supplementalDocumentsMustReadMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustRead property is editable.

supplementalDocumentsMustViewstring

When true, this user must view supplemental documents.

supplementalDocumentsMustViewMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustView property is editable.

suppressCertificateEnforcementstring

suppressCertificateEnforcementMetadatasettingsMetadata

Metadata that indicates whether the suppressCertificateEnforcement property is editable.

tabAccountSettingsAccountTabSettings

timezoneOffsetAPIstring

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

timezoneOffsetAPIMetadatasettingsMetadata

Metadata that indicates whether the timezoneOffsetAPI property is editable.

timezoneOffsetUIstring

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

timezoneOffsetUIMetadatasettingsMetadata

Metadata that indicates whether the timezoneOffsetUI property is editable.

universalSignatureOptInstring

Reserved for DocuSign.

useAccountLevelEmailstring

Reserved for DocuSign.

useAccountLevelEmailMetadatasettingsMetadata

Metadata that indicates whether the useAccountLevelEmail property is editable.

useConsumerDisclosurestring

If true, the account is using consumer disclosures.

useConsumerDisclosureMetadatasettingsMetadata

Metadata that indicates whether the useConsumerDisclosure property is editable.

useConsumerDisclosureWithinAccountstring

useConsumerDisclosureWithinAccountMetadatasettingsMetadata

Metadata that indicates whether the useConsumerDisclosureWithinAccount property is editable.

useDerivedKeysstring

Reserved for DocuSign.

useDerivedKeysMetadatasettingsMetadata

Metadata that indicates whether the useDerivedKeys property is editable.

useDocuSignExpressSignerCertificatestring

If true, signers are required to use Express Digital Signatures.

useDocuSignExpressSignerCertificateMetadatasettingsMetadata

Metadata that indicates whether the useDocuSignExpressSignerCertificate property is editable.

useNewBlobForPdfstring

Reserved for DocuSign.

useNewBlobForPdfMetadatasettingsMetadata

Metadata that indicates whether the useNewBlobForPdf property is editable.

useSAFESignerCertificatesstring

If true, signers are required to use SAFE digital signatures.

useSAFESignerCertificatesMetadatasettingsMetadata

Metadata that indicates whether the useSAFESignerCertificates property is editable.

usesAPIstring

If true, the account can use the API.

usesAPIMetadatasettingsMetadata

Metadata that indicates whether the usesAPI property is editable.

useSignatureProviderPlatformstring

useSignatureProviderPlatformMetadatasettingsMetadata

Metadata that indicates whether the useSignatureProviderPlatform property is editable.

validationsAllowedstring

validationsAllowedMetadatasettingsMetadata

Metadata that indicates whether the validationsAllowed property is editable.

validationsBrandstring

Valid values are:

  • docusign
  • account

validationsBrandMetadatasettingsMetadata

Metadata that indicates whether the validationsBrand property is editable.

validationsCadencestring

Valid values are:

  • none
  • monthly

validationsCadenceMetadatasettingsMetadata

Metadata that indicates whether the validationsCadence property is editable.

validationsEnabledstring

If true, enables validations.

validationsEnabledMetadatasettingsMetadata

Metadata that indicates whether the validationsEnabled property is editable.

validationsReportstring

Valid values are:

  • none
  • life_sciences_part11

validationsReportMetadatasettingsMetadata

Metadata that indicates whether the validationsReport property is editable.

waterMarkEnabledstring

If true, the watermark feature is enabled for the account.

waterMarkEnabledMetadatasettingsMetadata

Metadata that indicates whether the waterMarkEnabled property is editable.

writeReminderToEnvelopeHistorystring

If true, sent reminders are included in the envelope history.

writeReminderToEnvelopeHistoryMetadatasettingsMetadata

Metadata that indicates whether the writeReminderToEnvelopeHistory property is editable.

wurflMinAllowableScreenSizestring

The smallest screen allowed.

wurflMinAllowableScreenSizeMetadatasettingsMetadata

Metadata that indicates whether the wurflMinAllowableScreenSize property is editable.

accountSignatureProvider

Signature provider associated with the identity verification workflow. If empty, then this specific workflow is not intended for signers

signatureProviderNamestring

The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. The current provider list.

addressInformation

Contains address information.

address1string

The first line of the user's address. Maximum length: 100 characters.

address2string

The second line of the user's address. Maximum length: 100 characters.

citystring

The user's city.

countrystring

The user's country.

faxstring

A fax number associated with the address, if one is available.

phonestring

A phone number associated with the address.

postalCodestring

The user's postal code.

stateOrProvincestring

The user's state or province.

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

expirations

A complex element that specifies the expiration settings for the envelope.

expireAfterstring

An integer that sets the number of days a sent envelope is active before it expires.

In a response, a negative number indicates that the envelope has already expired.

expireEnabledstring

When set to true, the envelope expires (is no longer available for signing) a certain number of days after it is sent (the sentDateTime). Use the expireAfter property to set the number of days before an envelope expires.

If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

expireWarnstring

An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.

externalDocumentSources

boxnetEnabledstring

boxnetMetadatasettingsMetadata

dropboxEnabledstring

dropboxMetadatasettingsMetadata

googleDriveEnabledstring

googleDriveMetadatasettingsMetadata

oneDriveEnabledstring

oneDriveMetadatasettingsMetadata

salesforceEnabledstring

salesforceMetadatasettingsMetadata

idCheckConfiguration

authSteps[idCheckSecurityStep]

isDefaultstring

When set to true, indicates that the signature is the default signature for the user.

namestring

idCheckSecurityStep

authTypestring

reminders

A complex element that specifies reminder settings for the envelope

reminderDelaystring

An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.

reminderEnabledstring

When set to true, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.

reminderFrequencystring

An interger that sets the interval, in days, between reminder emails.

settingsMetadata

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

is21CFRPart11string

When set to true, indicates that this module is enabled on the account.

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

uiHintstring

Reserved for DocuSign.

uiOrderstring

Reserved for DocuSign.

uiTypestring

Reserved for DocuSign.

AccountTabSettings

allowTabOrderstring

allowTabOrderMetadatasettingsMetadata

Metadata that indicates whether the allowTabOrder property is editable.

approveDeclineTabsEnabledstring

approveDeclineTabsMetadatasettingsMetadata

Metadata that indicates whether the approveDeclineTabs property is editable.

calculatedFieldsEnabledstring

calculatedFieldsMetadatasettingsMetadata

Metadata that indicates whether the calculatedFields property is editable.

checkboxTabsEnabledstring

checkBoxTabsMetadatasettingsMetadata

dataFieldRegexEnabledstring

dataFieldRegexMetadatasettingsMetadata

Metadata that indicates whether the dataFieldRegex property is editable.

dataFieldSizeEnabledstring

dataFieldSizeMetadatasettingsMetadata

Metadata that indicates whether the dataFieldSize property is editable.

firstLastEmailTabsEnabledstring

firstLastEmailTabsMetadatasettingsMetadata

Metadata that indicates whether the firstLastEmailTabs property is editable.

listTabsEnabledstring

listTabsMetadatasettingsMetadata

Metadata that indicates whether the listTabs property is editable.

noteTabsEnabledstring

noteTabsMetadatasettingsMetadata

Metadata that indicates whether the noteTabs property is editable.

radioTabsEnabledstring

radioTabsMetadatasettingsMetadata

Metadata that indicates whether the radioTabs property is editable.

savingCustomTabsEnabledstring

savingCustomTabsMetadatasettingsMetadata

Metadata that indicates whether the savingCustomTabs property is editable.

senderToChangeTabAssignmentsEnabledstring

senderToChangeTabAssignmentsMetadatasettingsMetadata

Metadata that indicates whether the senderToChangeTabAssignments property is editable.

sharedCustomTabsEnabledstring

sharedCustomTabsMetadatasettingsMetadata

Metadata that indicates whether the sharedCustomTabs property is editable.

tabDataLabelEnabledstring

tabDataLabelMetadatasettingsMetadata

Metadata that indicates whether the tabDataLabel property is editable.

tabLocationEnabledstring

tabLocationMetadatasettingsMetadata

Metadata that indicates whether the tabLocation property is editable.

tabLockingEnabledstring

tabLockingMetadatasettingsMetadata

Metadata that indicates whether the tabLocking property is editable.

tabScaleEnabledstring

tabScaleMetadatasettingsMetadata

Metadata that indicates whether the tabScale property is editable.

tabTextFormattingEnabledstring

tabTextFormattingMetadatasettingsMetadata

Metadata that indicates whether the tabTextFormatting property is editable.

textTabsEnabledstring

textTabsMetadatasettingsMetadata

Metadata that indicates whether the textTabs property is editable.

Examples

Generic JSON Request

Request
{
  "accountSettings": [
    {}
  ]
}
Generic XML Request

Request
<accountSettingsInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <accountSettings>
    <nameValue />
  </accountSettings>
</accountSettingsInformation> 
}} />