DocuSign: Esignature schemas (part 22)
53 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Gets the user account settings for a specified user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following: - `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`) - `uiHint`: Internally used to build UIs (can be `available` or `hidden`) - `options`: The values supported for this setting (not all settings have this element) |
accountAgreementsAccessType | string | Optional | |
accountAgreementsAccessTypeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
accountManagementGranular | Model | Optional | Expand Gets the user account settings for a specified user — response body — account Management Granular Describes which account management capabilities a user has. |
adminOnly | string | Optional | Reserved for Docusign. |
adminOnlyMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
allowAccessToAllAccountAgreements | string | Optional | |
allowAccessToAllAccountAgreementsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
allowAutoTagging | string | Optional | When **true,** the API returns suggested tabs for documents for this user. |
allowEnvelopeTransferTo | string | Optional | When **true,** this user can participate in envelope transfers on the account. |
allowEnvelopeTransferToMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
allowEsealRecipients | string | Optional | When **true,** this user can create [electronic seal recipients][eseal]. [eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient |
allowEsealRecipientsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `allowEsealRecipientsMetadata` property. |
allowPowerFormsAdminToAccessAllPowerFormEnvelope | string | Optional | When **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.** |
allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata` property. |
allowRecipientLanguageSelection | string | Optional | When **true,** this user can set the language used in the standard email format for a recipient when creating an envelope. |
allowRecipientLanguageSelectionMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata for allowRecipientLanguageSelection. |
allowSendOnBehalfOf | string | Optional | When **true,** this user can send envelopes "on behalf of" other users through the API. |
allowSendOnBehalfOfMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata for allowSendOnBehalfOf. |
allowSupplementalDocuments | string | Optional | When **true,** this user can include supplemental documents. |
allowSupplementalDocumentsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowSupplementalDocuments` property is editable. |
allowTransactions | string | Optional | |
allowTransactionsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
allowedDocumentTemplateLibraryAccess | string | Optional | |
allowedDocumentTemplateLibraryAccessMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
allowedOrchestrationAccess | string | Optional | |
allowedOrchestrationAccessMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
anchorTagVersionedPlacementEnabled | string | Optional | Reserved for Docusign. |
apiAccountWideAccess | string | Optional | When **true,** indicates that this user can send envelope-specific API requests on the account. |
apiAccountWideAccessMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata for apiAccountWideAccess. |
apiCanExportAC | string | Optional | When **true,** this user can export authoritative copy for the account. |
apiCanExportACMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `apiCanExportACMetadata` property. |
bulkSend | string | Optional | When **true,** this user can use the bulk send feature for the account. |
bulkSendMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `bulkSend` property is editable. |
canBulkUploadAgreements | string | Optional | |
canBulkUploadAgreementsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canChargeAccount | string | Optional | Reserved for Docusign. |
canChargeAccountMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
canCreateTransaction | string | Optional | |
canCreateTransactionMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canDeleteDocumentsInTransaction | string | Optional | |
canDeleteDocumentsInTransactionMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canDeleteTransaction | string | Optional | |
canDeleteTransactionMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canEditSharedAddressbook | string | Optional | When true, this user can edit the shared address book for the account. |
canEditSharedAddressbookMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `canEditSharedAddressbookMetadata` property. |
canLockEnvelopes | string | Optional | Reserved for Docusign. |
canLockEnvelopesMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
canManageAccount | string | Optional | When **true,** this user is an administrator for the account. |
canManageAccountMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `canManageAccountMetadata` property. |
canManageAgreementParties | string | Optional | |
canManageAgreementPartiesMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageDistributor | string | Optional | Reserved for Docusign. |
canManageDistributorMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `canManageDistributor` property. |
canManageTemplates | string | Optional | When **true,** this user can manage templates for the account. |
canManageTemplatesMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `canManageTemplates` property. |
canSendAPIRequests | string | Optional | When **true,** this user can send API requests on the account. |
canSendAPIRequestsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `canSendAPIRequests` property. |
canSendEnvelope | string | Optional | When **true,** this user can send envelopes on the account. |
canSendEnvelopeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `canSendEnvelope` property. |
canSendEnvelopesViaSMS | string | Optional | |
canSendEnvelopesViaSMSMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canSignEnvelope | string | Optional | When **true,** this user can sign envelopes. |
canSignEnvelopeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `canSignEnvelope` property. |
canUseScratchpad | string | Optional | When **true,** this user can use a scratchpad to edit information. |
canUseScratchpadMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `canUseScratchpad` property. |
canUseSmartContracts | string | Optional | Reserved for Docusign. |
canUseSmartContractsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
disableDocumentUpload | string | Optional | When **true,** this user is prohibited from uploading documents during sending. |
disableDocumentUploadMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `disableDocumentUpload` property is editable. |
disableOtherActions | string | Optional | When **true,** this user can access the **Other Actions** menu. |
disableOtherActionsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `disableOtherActions` property is editable. |
enableDSPro | string | Optional | Reserved for Docusign. |
enableDSProMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `enableDSPro` property is editable. |
enableKeyTermsSuggestionsByDocumentType | string | Optional | |
enableKeyTermsSuggestionsByDocumentTypeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
enableSequentialSigningAPI | string | Optional | When **true,** the account can define the routing order of recipients for envelopes sent by using the eSignature API. **Note:** Only SysAdmin users can change this setting. |
enableSequentialSigningAPIMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `enableSequentialSigningAPI` property is editable. |
enableSequentialSigningUI | string | Optional | When **true,** the account can define the routing order of recipients for envelopes sent by using the Docusign application. **Note:** Only SysAdmin users can change this setting. |
enableSequentialSigningUIMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `enableSequentialSigningUI` property is editable. |
enableSignOnPaperOverride | string | Optional | When **true,** a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically. **Note:** Only Admin users can change this setting. |
enableSignOnPaperOverrideMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `enableSignOnPaperOverride` property is editable. |
enableSignerAttachments | string | Optional | When **true,** this user can use the signing attachments feature. |
enableSignerAttachmentsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `enableSignerAttachments` property is editable. |
enableTransactionPoint | string | Optional | Reserved for Docusign. |
enableTransactionPointMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
enableVaulting | string | Optional | When **true,** Vaulting is enabled for the account. |
enableVaultingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `enableVaulting` property is editable. |
expressSendOnly | string | Optional | When **false,** this user can apply tabs to documents during the sending experience. |
isManagedByScim | string | Optional | |
isManagedByScimMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
isMembershipManagedByScim | string | Optional | |
isMembershipManagedByScimMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
locale | string | Optional | The user's locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es` |
localeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `locale` property. |
localePolicy | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Policy Locale-specific settings. |
manageClickwrapsMode | string | Optional | When **true,** this user can create and manage [Clickwraps](/docs/click-api/). |
manageClickwrapsModeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `manageClickwrapsMode` property. |
modifiedBy | string | Optional | The user ID (GUID) of the user who last modified this user record. This property is read-only. |
modifiedByMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `modifiedBy` property. |
modifiedDate | string | Optional | The date on which this user record was last modified. |
modifiedDateMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `modifiedDate` property. |
modifiedPage | string | Optional | Note referencing the page that modified this user record. |
modifiedPageMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `modifiedPage` property. |
newSendUI | string | Optional | Reserved for Docusign. |
newSendUIMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `newSendUI` property. |
powerFormMode | string | Optional | Indicates the Power Form mode setting for the user: - `none` - `admin` - `user` |
powerFormModeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `powerFormMode` property. |
recipientViewedNotification | string | Optional | When **true,** this user receives notifications when envelopes are viewed. |
recipientViewedNotificationMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `recipientViewedNotification` property. |
sealIdentifiers | array | Optional | Information about the seals associated with this user. |
sealIdentifiers[] | Model | Each item | Expand Returns available seals for specified account — response body — seals item |
selfSignedRecipientEmailDocument | string | Optional | Sets how self-signed documents are presented to the email recipients. Valid values are: - `include_pdf`: A PDF of the completed document is attached to the email. - `include_link`: A secure link to the self-signed documents is included in the email. **Note:** Only Admin users can change this setting. |
selfSignedRecipientEmailDocumentMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `selfSignedRecipientEmailDocument` property is editable. |
senderEmailNotifications | Model | Optional | Expand Gets the user account settings for a specified user — response body — sender Email Notifications An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from Docusign. The user inherits the default account sender email notification settings when the user is created. The email notifications are: * envelopeComplete * changedSigner * senderEnvelopeDeclined * withdrawnConsent * recipientViewed * deliveryFailed |
signerEmailNotifications | Model | Optional | Expand Gets the user account settings for a specified user — response body — signer Email Notifications An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from Docusign. The user inherits the default account email notification settings when the user is created. |
supplementalDocumentIncludeInDownload | string | Optional | When **true,** this user gets supplemental documents when downloading documents. |
supplementalDocumentsMustAccept | string | Optional | When **true,** this user must accept supplemental documents. |
supplementalDocumentsMustAcceptMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable. |
supplementalDocumentsMustRead | string | Optional | When **true,** this user must both view and accept supplemental documents. |
supplementalDocumentsMustReadMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable. |
supplementalDocumentsMustView | string | Optional | When **true,** this user must view supplemental documents. |
supplementalDocumentsMustViewMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `supplementalDocumentsMustView` property is editable. |
templateActiveCreation | string | Optional | When **true,** a new template is created each time the user sends an envelope. |
templateActiveCreationMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `templateActiveCreation` property. |
templateApplyNotify | string | Optional | When **true,** the system notifies this user before applying a matching template. |
templateApplyNotifyMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `templateApplyNotify` property. |
templateAutoMatching | string | Optional | When **true,** the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from. |
templateAutoMatchingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `templateAutoMatching` property. |
templateMatchingSensitivity | string | Optional | Percentage used when matching templates. |
templateMatchingSensitivityMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `tempalteMatchingSensitivity` property. |
templatePageLevelMatching | string | Optional | When **true,** users see template matching functionality. |
templatePageLevelMatchingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `templatePageLevelMatching` property. |
timezoneDST | string | Optional | When true, daylight savings time is in effect for this user's time zone. |
timezoneDSTMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `timezoneDST` property. |
timezoneMask | string | Optional | The custom DateTime format setting for this user. |
timezoneMaskMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `timezoneMask` property. |
timezoneOffset | string | Optional | The timezone offset for the user. Valid values: - `tz_01_afghanistan` - `tz_02_alaskan` - `tz_03_arab` - `tz_04_arabian` - `tz_05_arabic` - `tz_06_argentina` - `tz_07_atlantic` - `tz_08_aus_central` - `tz_09_aus_eastern` - `tz_10_azerbaijan` - `tz_11_azores` - `tz_12_bangladesh` - `tz_13_canada_central` - `tz_14_cape_verde` - `tz_15_caucasus` - `tz_16_central_australia` - `tz_17_central_america` - `tz_18_central_asia` - `tz_19_central_brazilian` - `tz_20_central_europe` - `tz_21_central_european` - `tz_22_central_pacific` - `tz_23_central` - `tz_24_central_mexico` - `tz_25_china` - `tz_26_dateline` - `tz_27_east_africa` - `tz_28_east_australia` - `tz_29_east_europe` - `tz_30_east_south_america` - `tz_31_eastern` - `tz_32_egypt` - `tz_33_ekaterinburg` - `tz_34_fiji` - `tz_35_fli` - `tz_36_georgian` - `tz_37_gmt` - `tz_38_greenland` - `tz_39_greenwich` - `tz_40_gtb` - `tz_41_hawaiian` - `tz_42_india` - `tz_43_iran` - `tz_44_israel` - `tz_45_jordan` - `tz_46_kaliningrad` - `tz_47_kamchatka` - `tz_48_korea` - `tz_49_magadan` - `tz_50_mauritius` - `tz_51_mid_atlantic` - `tz_52_middle_east` - `tz_53_montevideo` - `tz_54_morocco` - `tz_55_mountain` - `tz_56_mountain_mexico` - `tz_57_myanmar` - `tz_58_north_central_asia` - `tz_59_namibia` - `tz_60_nepal` - `tz_61_new_zealand` - `tz_62_new_foundland` - `tz_63_north_asia_east` - `tz_64_north_asia` - `tz_65_pacific_sa` - `tz_66_pacific` - `tz_67_pacific_mexico` - `tz_68_pakistan` - `tz_69_paraguay` - `tz_70_romance` - `tz_71_russian` - `tz_72_sa_eastern` - `tz_73_sa_pacific` - `tz_74_sa_western` - `tz_75_samoa` - `tz_76_se_asia` - `tz_77_singapore` - `tz_78_south_africa` - `tz_79_sriLanka` - `tz_80_syria` - `tz_81_taipei` - `tz_82_tasmania` - `tz_83_tokyo` - `tz_84_tonga` - `tz_85_turkey` - `tz_86_ulaanbaatar` - `tz_87_us_eastern` - `tz_88_us_mountain` - `tz_89_venezuela` - `tz_90_vladivostok` - `tz_91_west_australia` - `tz_92_west_central_africa` - `tz_93_west_europe` - `tz_94_west_asia` - `tz_95_west_pacific` - `tz_96_yakutsk` |
timezoneOffsetMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `timezoneOffset` property. |
timezoneSendingPref | string | Optional | Reserved for Docusign. |
timezoneSendingPrefMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
timezoneSigningPref | string | Optional | Reserved for Docusign. |
timezoneSigningPrefMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
transactionPointSiteNameURL | string | Optional | Reserved for Docusign. |
transactionPointSiteNameURLMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
transactionPointUserName | string | Optional | Reserved for Docusign. |
transactionPointUserNameMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
vaultingMode | string | Optional | Indicates the specified Vaulting mode: - `none` - `estored` - `electronic_original` |
vaultingModeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata about the `vaultingMode` property. |
webForms | string | Optional | |
webFormsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
Referenced models: Gets the user account settings for a specified user — response body — locale Policy, Returns available seals for specified account — response body — seals item, Gets the user account settings for a specified user — response body — sender Email Notifications, Gets the user account settings for a specified user — response body — locale Metadata, Gets the user account settings for a specified user — response body — signer Email Notifications, Gets the user account settings for a specified user — response body — account Management Granular
Gets the user account settings for a specified user — response body — account Management Granular
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes which account management capabilities a user has. |
canManageAccountSecuritySettings | string | Optional | **True** if the user can manage account security settings. |
canManageAccountSecuritySettingsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageAccountSettings | string | Optional | **True** if the user can manage account settings. |
canManageAccountSettingsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageAdmins | string | Optional | **True** if the user can manage administrators. |
canManageAdminsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `canManageAdmins` property is editable. |
canManageConnect | string | Optional | |
canManageConnectMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageDocumentRetention | string | Optional | |
canManageDocumentRetentionMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageEnvelopeTransfer | string | Optional | |
canManageEnvelopeTransferMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageGroupsButNotUsers | string | Optional | |
canManageGroupsButNotUsersMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageJointAgreements | string | Optional | |
canManageJointAgreementsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageReporting | string | Optional | **True** if the user can manage reporting. |
canManageReportingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageSharing | string | Optional | **True** if the user can manage sharing. |
canManageSharingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `canManageSharing` property is editable. |
canManageSigningGroups | string | Optional | **True** if the user can manage signing groups. |
canManageSigningGroupsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageStamps | string | Optional | |
canManageStampsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageUsers | string | Optional | **True** if the user can manage users. |
canManageUsersMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `canManageUsers` property is editable. |
canViewUsers | string | Optional |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Gets the user account settings for a specified user — response body — locale Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata that indicates whether a property is editable and describes setting-specific options. |
is21CFRPart11 | string | Optional | When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
options | array | Optional | An array of option strings supported by this setting. |
options[] | string | Each item | |
rights | string | Optional | Indicates whether the property is editable. Valid values are: - `editable` - `read_only` |
uiHint | string | Optional | Reserved for Docusign. |
uiOrder | string | Optional | Reserved for Docusign. |
uiType | string | Optional | Reserved for Docusign. |
Gets the user account settings for a specified user — response body — locale Policy
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
addressFormat | string | Optional | Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw` |
addressFormatMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates if the `addressFormat` property is editable. |
allowRegion | string | Optional | |
calendarType | string | Optional | Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist` |
calendarTypeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `calendarType` property is editable. |
cultureName | string | Optional | The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. |
cultureNameMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `cultureName` property is editable. |
currencyCode | string | Optional | The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. |
currencyCodeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `currencyCode` property is editable. |
currencyNegativeFormat | string | Optional | Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00` |
currencyNegativeFormatMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `currencyNegativeFormat` property is editable. |
currencyPositiveFormat | string | Optional | Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR) |
currencyPositiveFormatMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `currencyPositiveFormat` property is editable. |
customDateFormat | string | Optional | |
customSignDateFormat | string | Optional | |
customSignTimeFormat | string | Optional | |
customTimeFormat | string | Optional | |
dateFormat | string | Optional | Specifies the date format. Valid values: - `default` <br> used the UI's - `longformat` <br> use the UI's long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d |
dateFormatMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `dateFormat` property is editable. |
effectiveAddressFormat | string | Optional | |
effectiveCalendarType | string | Optional | |
effectiveCurrencyCode | string | Optional | |
effectiveCurrencyNegativeFormat | string | Optional | |
effectiveCurrencyPositiveFormat | string | Optional | |
effectiveCustomDateFormat | string | Optional | |
effectiveCustomTimeFormat | string | Optional | |
effectiveDateFormat | string | Optional | |
effectiveInitialFormat | string | Optional | |
effectiveNameFormat | string | Optional | |
effectiveTimeFormat | string | Optional | |
effectiveTimeZone | string | Optional | |
initialFormat | string | Optional | When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs --> |
initialFormatMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `initialFormat` property is editable. |
nameFormat | string | Optional | Describes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 --> |
nameFormatMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `nameFormat` property is editable. |
signDateFormat | string | Optional | 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. |
signDateFormatMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `signDateFormat` property is editable. |
signTimeFormat | string | Optional | The format for the signature time. Valid values are: - `none` - `HH:mm` - `h:mm` - `HH:mm:ss` - `h:mm:ss` |
signTimeFormatMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `signTimeFormat` property is editable. |
timeFormat | string | Optional | Specifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 --> |
timeFormatMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `timeFormat` property is editable. |
timeZone | string | Optional | Specifies the time zone. Valid values: - `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` |
timeZoneMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `timeZone` property is editable. |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Gets the user account settings for a specified user — response body — sender Email Notifications
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the settings for the email notifications that senders receive about the envelopes that they send. |
changedSigner | string | Optional | When **true,** the sender receives an email notification if the signer changes. |
clickwrapResponsesLimitNotificationEmail | string | Optional | |
commentsOnlyPrivateAndMention | string | Optional | When **true,** the user receives only comments that mention their own user name. |
commentsReceiveAll | string | Optional | When **true,** the user receives all comments. |
deliveryFailed | string | Optional | When **true,** the sender receives an email notification if envelope delivery fails. |
envelopeComplete | string | Optional | When **true,** the user receives an email notification when the envelope has been completed. |
offlineSigningFailed | string | Optional | When **true,** the user receives an email notification if offline signing failed. |
powerformResponsesLimitNotificationEmail | string | Optional | |
purgeDocuments | string | Optional | When **true,** the user receives an email notification when a document purge occurs. |
recipientViewed | string | Optional | When **true,** the sender receives notification that a recipient viewed the envelope. |
senderEnvelopeDeclined | string | Optional | When **true,** the sender receives notification that the envelope was declined. |
withdrawnConsent | string | Optional | When **true,** the user receives an email notification if consent is withdrawn. |
Gets the user account settings for a specified user — response body — signer Email Notifications
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from Docusign. The user inherits the default account email notification settings when the user is created. |
agentNotification | string | Optional | When **true,** the user receives agent notification emails. |
carbonCopyNotification | string | Optional | When **true,** the user receives notifications of carbon copy deliveries. |
certifiedDeliveryNotification | string | Optional | When **true,** the user receives notifications of certified deliveries. |
commentsOnlyPrivateAndMention | string | Optional | When **true,** the user receives only comments that mention their own user name. |
commentsReceiveAll | string | Optional | When **true,** the user receives all comments. |
documentMarkupActivation | string | Optional | When **true,** the user receives notification that document markup has been activated. |
envelopeActivation | string | Optional | When **true,** the user receives notification that the envelope has been activated. |
envelopeComplete | string | Optional | When **true,** the user receives an email notification when the envelope has been completed. |
envelopeCorrected | string | Optional | When **true,** the user receives notification that the envelope has been corrected. |
envelopeDeclined | string | Optional | When **true,** the user receives notification that the envelope has been declined. |
envelopeVoided | string | Optional | When **true,** the user receives notification that the envelope has been voided. |
faxReceived | string | Optional | Reserved for Docusign. |
offlineSigningFailed | string | Optional | When **true,** the user receives an email notification if offline signing failed. |
purgeDocuments | string | Optional | When **true,** the user receives an email notification when a document purge occurs. |
reassignedSigner | string | Optional | When **true,** the user receives notification that the envelope has been reassigned. |
whenSigningGroupMember | string | Optional | When **true,** the user receives notification that he or she is a member of the signing group. |
Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | User information. |
activationAccessCode | string | Optional | Access code provided to the user to activate the account. |
company | string | Optional | The name of the user's company. |
connectConfigurations | array | Optional | Object representing the user's custom Connect configuration. |
connectConfigurations[] | Model | Each item | Expand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — connect Configurations item |
countryCode | string | Optional | The two-letter code for the user's country. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
customSettings | array | Optional | The name/value pair information for the user custom setting. |
customSettings[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
defaultAccountId | string | Optional | The default account ID associated with the user. |
email | string | Optional | The user's email address. This property cannot be updated via `PUT` requests. |
enableConnectForUser | string | Optional | Boolean value that specifies whether the user is enabled for updates from Docusign Connect. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
firstName | string | Optional | The user's first name. Maximum Length: 50 characters. |
forgottenPasswordInfo | Model | Optional | Expand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — forgotten Password Info A complex element containing up to four Question/Answer pairs for forgotten password information. |
groupList | array | Optional | A list of the group information for groups to add the user to. Use [UserGroups: listGroups](/docs/esign-rest-api/reference/usergroups/groups/list/) to get information about groups. When setting a user's group, only the `groupId` is required. |
groupList[] | Model | Each item | Expand Deletes an existing user group — response body — groups item |
hasRemoteNotary | boolean | Optional | |
homeAddress | Model | Optional | Expand Get credit card information — response body — address Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. Maximum Length: 100 characters. |
initialsImageUri | string | Optional | The URI for retrieving the image of the user's initials. |
isAdmin | string | Optional | When **true,** the user is an administrator. |
isAlternateAdmin | string | Optional | When **true,** the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed. |
isManagedByScim | string | Optional | |
isMembershipManagedByScim | string | Optional | |
isNAREnabled | string | Optional | When **true,** National Association of Realtors (NAR) signature logos are enabled for the user. |
jobTitle | string | Optional | The user's job title. |
lastLogin | string | Optional | This property has been deprecated. |
lastName | string | Optional | The user's last name. Maximum Length: 50 characters. |
licenseStatus | string | Optional | |
licenseType | string | Optional | |
loginStatus | string | Optional | Boolean value that indicates whether the user is currently logged in or not. |
middleName | string | Optional | The user's middle name. Limit: 50 characters. |
password | string | Optional | The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests. |
passwordExpiration | string | Optional | If password expiration is enabled, the date-time when the user's password expires. |
permissionProfileId | string | Optional | The ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the **Settings > Permission Profiles** page of your eSignature account page. |
permissionProfileName | string | Optional | The name of the account permission profile. Example: `Account Administrator` |
profileImageUri | string | Optional | The URL for retrieving the user's profile image. |
sendActivationEmail | string | Optional | This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). |
sendActivationOnInvalidLogin | string | Optional | When **true,** specifies that an additional activation email be sent if user's log on fails before the account is activated. |
signatureImageUri | string | Optional | An endpoint URI that you can use to retrieve the user's signature image. |
subscribe | string | Optional | |
suffixName | string | Optional | The suffix for the user's name, such as Jr, IV, PhD, etc. Limit: 50 characters. |
title | string | Optional | The title of the user. |
uri | string | Optional | A URI containing the user ID. |
userAddedToAccountDateTime | string | Optional | The date and time that the user was added to the account. |
userId | string | Optional | The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. |
userName | string | Optional | The name of the user. |
userProfileLastModifiedDate | string | Optional | The date and time that the user's profile was last modified. |
userSettings | Model | Optional | Expand Gets the user account settings for a specified user — response body The collection of settings representing the actions a user can perform. See [userSettingsInformation](/docs/esign-rest-api/reference/users/users/get/#userSettingsInformation) for available settings. |
userStatus | string | Optional | Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` |
userType | string | Optional | The type of user, for example `CompanyUser`. |
workAddress | Model | Optional | Expand Get credit card information — response body — address |
Referenced models: Get credit card information — response body — address, Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — connect Configurations item, Locks a template — response body — error Details, Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — forgotten Password Info, Deletes an existing user group — response body — groups item, Updates an existing brand — response body — colors item, Gets the user account settings for a specified user — response body
Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — connect Configurations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
configurationtype | string | Optional | The type of custom Connect configuration being accessed. |
connectId | string | Optional | The ID of the custom Connect configuration being accessed. |
enabled | string | Optional | Boolean value that indicates whether the custom Connect configuration is enabled or not. |
hasAccess | string | Optional | |
senderSearchableItems | array | Optional | |
senderSearchableItems[] | string | Each item |
Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body — forgotten Password Info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that has up to four Question/Answer pairs for forgotten password information. |
forgottenPasswordAnswer1 | string | Optional | The answer to the first forgotten password challenge question. |
forgottenPasswordAnswer2 | string | Optional | The answer to the second forgotten password challenge question. |
forgottenPasswordAnswer3 | string | Optional | The answer to the third forgotten password challenge question. |
forgottenPasswordAnswer4 | string | Optional | The answer to the fourth forgotten password challenge question. |
forgottenPasswordQuestion1 | string | Optional | The first challenge question presented to a user who has forgotten their password. |
forgottenPasswordQuestion2 | string | Optional | The second challenge question presented to a user who has forgotten their password. |
forgottenPasswordQuestion3 | string | Optional | The third challenge question presented to a user who has forgotten their password. |
forgottenPasswordQuestion4 | string | Optional | The fourth challenge question presented to a user who has forgotten their password. |
Initiate a new chunked upload — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This is the request object for uploading a chunked upload. |
chunkedUploadId | string | Optional | The ID of the chunked upload. **Note:** This property is ignored in requests, and overridden with an auto-generated value in responses. |
data | string | Optional | A base64-encoded representation of the content that is used to upload the file. Maximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size. |
List File Pages — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
pages | array | Optional | An array of page objects. |
pages[] | Model | Each item | Expand Creates a workspace file — response body — thumbnail |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Creates a workspace file — response body — thumbnail
List Workspaces — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains a list of available workspaces. |
endPosition | string | Optional | The last index position in the result set. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
workspaces | array | Optional | A list of workspaces. |
workspaces[] | Model | Each item | Expand Get Workspace — response body |
Referenced models: Get Workspace — response body
List workspace folder contents — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object's properties describe the contents of a workspace folder. |
endPosition | string | Optional | The last index position in the result set. |
folder | Model | Optional | Expand Creates a workspace file — response body The folder from which to return items. You can enter either the folder name or folder ID. |
items | array | Optional | A list of workspace items. |
items[] | Model | Each item | Expand Creates a workspace file — response body |
parentFolders | array | Optional | |
parentFolders[] | Model | Each item | Expand Creates a workspace file — response body |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
workspaceId | string | Optional | The ID of the workspace, always populated. |
Referenced models: Creates a workspace file — response body
Lists resources for REST version specified — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
resources | array | Optional | |
resources[] | Model | Each item | Expand Updates an existing brand — response body — colors item |
Referenced models: Updates an existing brand — response body — colors item
Locks a template — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This request object contains information about the lock that you want to create or update. |
lockDurationInSeconds | string | Optional | The number of seconds to lock the envelope for editing. Must be greater than 0 seconds. |
lockType | string | Optional | The type of lock. Currently `edit` is the only supported type. |
lockedByApp | string | Optional | A friendly name of the application used to lock the envelope. Will be used in error messages to the user when lock conflicts occur. |
templatePassword | string | Optional | The [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the `templatePassword` to save the changes. |
useScratchPad | string | Optional | When **true,** a scratchpad is used to edit information. |
Locks a template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
lockDurationInSeconds | string | Optional | The number of seconds to lock the envelope for editing. This value must be greater than `0` seconds. |
lockToken | string | Optional | A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock. |
lockType | string | Optional | The type of lock. Currently `edit` is the only supported type. |
lockedByApp | string | Optional | The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur. |
lockedByUser | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner A complex type containing information about the user that has the envelope or template locked. |
lockedUntilDateTime | string | Optional | The date and time that the lock expires. |
useScratchPad | string | Optional | When **true,** a scratchpad is used to edit information. |
Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner
Locks a template — response body — error Details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object describes errors that occur. It is only valid for responses and ignored in requests. |
errorCode | string | Optional | The code associated with the error condition. |
message | string | Optional | A brief message describing the error condition. |
Locks an envelope — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
lockDurationInSeconds | string | Optional | The number of seconds until the lock expires when there is no activity on the envelope. The default value is 300 seconds. The maximum value is 1,800 seconds. The lock duration can be extended. |
lockToken | string | Optional | A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock. |
lockType | string | Optional | The type of lock. Currently `edit` is the only supported type. |
lockedByApp | string | Optional | The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur. |
lockedByUser | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner A complex type containing information about the user that has the envelope or template locked. |
lockedUntilDateTime | string | Optional | The date and time that the lock expires. |
useScratchPad | string | Optional | When **true,** a scratchpad is used to edit information. |
Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner
Modifies tab settings for specified account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allowTabOrder | string | Optional | When **true,** account users can set a tab order for the signing process. **Note:** Only Admin users can change this setting. |
allowTabOrderMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowTabOrder` property is editable. |
approveDeclineTabsEnabled | string | Optional | When **true,** approve and decline tabs are enabled. |
approveDeclineTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `approveDeclineTabs` property is editable. |
calculatedFieldsEnabled | string | Optional | When **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs. |
calculatedFieldsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `calculatedFields` property is editable. |
checkBoxTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `checkBoxTabs` property is editable. |
checkboxTabsEnabled | string | Optional | When **true,** checkbox tabs are enabled. |
dataFieldRegexEnabled | string | Optional | When **true,** regular expressions are enabled for tabs that contain data fields. |
dataFieldRegexMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `dataFieldRegex` property is editable. |
dataFieldSizeEnabled | string | Optional | When **true,** setting character limits for input fields is enabled. |
dataFieldSizeMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `dataFieldSize` property is editable. |
drawTabsEnabled | string | Optional | |
drawTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
enableTabAgreementDetails | string | Optional | |
enableTabAgreementDetailsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
firstLastEmailTabsEnabled | string | Optional | Reserved for Docusign. |
firstLastEmailTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
listTabsEnabled | string | Optional | When **true,** list tabs are enabled. |
listTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `listTabs` property is editable. |
noteTabsEnabled | string | Optional | When **true,** note tabs are enabled. |
noteTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `noteTabs` property is editable. |
numericalTabsEnabled | string | Optional | |
numericalTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
prefillTabsEnabled | string | Optional | |
prefillTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
radioTabsEnabled | string | Optional | When **true,** radio button tabs are enabled. |
radioTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `radioTabs` property is editable. |
savingCustomTabsEnabled | string | Optional | When **true,** saving custom tabs is enabled. |
savingCustomTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `savingCustomTabs` property is editable. |
senderToChangeTabAssignmentsEnabled | string | Optional | Reserved for Docusign. |
senderToChangeTabAssignmentsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
sharedCustomTabsEnabled | string | Optional | When **true,** shared custom tabs are enabled. |
sharedCustomTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `sharedCustomTabs` property is editable. |
tabDataLabelEnabled | string | Optional | When **true,** [data labels](https://support.docusign.com/en/videos/Data-Labels) are enabled. **Note:** Only Admin users can change this setting. |
tabDataLabelMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `tabDataLabel` property is editable. |
tabLocationEnabled | string | Optional | Reserved for Docusign. |
tabLocationMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
tabLockingEnabled | string | Optional | When **true,** tab locking is enabled. **Note:** Only Admin users can change this setting. |
tabLockingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `tabLocking` property is editable. |
tabScaleEnabled | string | Optional | Reserved for Docusign. |
tabScaleMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Reserved for Docusign. |
tabTextFormattingEnabled | string | Optional | When **true,** text formatting (such as font type, font size, font color, bold, italic, and underline) is enabled for tabs that support formatting. **Note:** Only Admin users can change this setting. |
tabTextFormattingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `tabTextFormatting` property is editable. |
textTabsEnabled | string | Optional | When **true,** text tabs are enabled. |
textTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `textTabs` property is editable. |
uriTabsEnabled | string | Optional | |
uriTabsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Moves a set of envelopes from their current folder to another folder — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information for a folder request. |
envelopeIds | array | Optional | An array of envelope ID GUIDs. |
envelopeIds[] | string | Each item | |
folders | array | Optional | Not used. |
folders[] | Model | Each item | Expand Creates an envelope — request body — body folders item |
fromFolderId | string | Optional | The ID of the folder that the envelope is being moved from. |
Referenced models: Creates an envelope — request body — body folders item
Posts a payment to a past due invoice — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
paymentAmount | string | Optional | The payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices. |
Posts a payment to a past due invoice — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines an billing payment response object. |
billingPayments | array | Optional | Reserved for Docusign. |
billingPayments[] | Model | Each item | Expand Posts a payment to a past due invoice — response body — billing Payments item |
Referenced models: Posts a payment to a past due invoice — response body — billing Payments item
Posts a payment to a past due invoice — response body — billing Payments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information on a billing plan. |
amount | string | Optional | Reserved for Docusign. |
invoiceId | string | Optional | Reserved for Docusign. |
paymentId | string | Optional | The ID of the payment. |
Queues downgrade billing plan request for an account — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
downgradeEventType | string | Optional | |
planInformation | Model | Optional | Expand Updates an account billing plan — request body — body plan Information An object used to identify the features and attributes of the account being created. |
promoCode | string | Optional | |
saleDiscount | string | Optional | |
saleDiscountPeriods | string | Optional | Reserved for Docusign. |
saleDiscountType | string | Optional |
Referenced models: Updates an account billing plan — request body — body plan Information
Queues downgrade billing plan request for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountPaymentMethod | string | Optional | The type of payment method used for the account. Valid values are: - `credit_card` - |
discountApplied | string | Optional | |
downgradeEffectiveDate | string | Optional | |
downgradePaymentCycle | string | Optional | |
downgradePlanId | string | Optional | |
downgradePlanName | string | Optional | |
downgradeRequestStatus | string | Optional | |
message | string | Optional | |
productId | string | Optional | The Product ID from the AppStore. |
promoCode | string | Optional | |
saleDiscount | string | Optional | |
saleDiscountPeriods | string | Optional | Reserved for Docusign. |
saleDiscountType | string | Optional |
Registers the current user as a notary — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
createdDate | string | Optional | The creation date of the account in UTC timedate format. |
enabled | string | Optional | The date the this object was created. |
searchable | string | Optional | When **true,** this notary is searchable. |
userInfo | Model | Optional | Expand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body Information about the user registering to be a notary. |
Referenced models: Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
Republishes Connect information for multiple envelopes — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of failed envelope IDs to retry. |
envelopeIds | array | Optional | An array of envelope GUIDs. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
envelopeIds[] | string | Each item | |
synchronous | string | Optional | Must be **false.** Setting this property to any other value will result in errors. |
Republishes Connect information for multiple envelopes — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
retryQueue | array | Optional | Details about a Connect failure result. |
retryQueue[] | Model | Each item | Expand Republishes Connect information for multiple envelopes — response body — retry Queue item |
Referenced models: Republishes Connect information for multiple envelopes — response body — retry Queue item
Republishes Connect information for multiple envelopes — response body — retry Queue item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains details about a Connect failure result. |
configId | string | Optional | Reserved for Docusign. |
configUrl | string | Optional | Reserved for Docusign. |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
status | string | Optional | The connection status. |
statusMessage | string | Optional | A human-readable message describing the connection status. |
Reserved: Gets the shared item status for one or more users — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains shared access information. |
accountId | string | Optional | The account ID associated with the envelope. |
endPosition | string | Optional | The last index position in the result set. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details A complex type containing an errorCode and message identifying the error that occurred. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
sharedAccess | array | Optional | A list of shared access information of envelope and templates for the users specified in the request. |
sharedAccess[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
Referenced models: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item
Reserved: Gets the shared item status for one or more users — response body — shared Access item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about shared items. |
envelopes | array | Optional | List of information about shared envelopes. |
envelopes[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item envelopes item |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
folders | array | Optional | List of information about shared folders. |
folders[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item |
templates | array | Optional | List of information about shared templates. |
templates[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item templates item |
user | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user requesting sharing information. |
Referenced models: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item, Reserved: Gets the shared item status for one or more users — response body — shared Access item envelopes item, Reserved: Gets the shared item status for one or more users — response body — shared Access item templates item, Gets a specific template associated with a specified account — response body — owner
Reserved: Gets the shared item status for one or more users — response body — shared Access item envelopes item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the shared item. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
shared | string | Optional | How the item is shared. One of: - `not_shared` - `shared_to` - `shared_from` - `shared_to_and_from` |
user | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who owns the shared item. |
Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner
Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
folderId | string | Optional | The ID of the folder. |
name | string | Optional | The name of the folder. |
owner | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who owns the folder. |
parentFolderId | string | Optional | The ID of the parent folder. |
parentFolderUri | string | Optional | The URI for the parent folder. |
shared | string | Optional | Indicates how the folder is shared. Valid values are: - `not_shared` - `shared_to` |
sharedGroups | array | Optional | A list of groups that share the folder. |
sharedGroups[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item |
sharedUsers | array | Optional | A list of users that share the folder. |
sharedUsers[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item |
uri | string | Optional | A URI containing the user ID. |
user | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user associated with the folder. |
Referenced models: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item, Gets a specific template associated with a specified account — response body — owner, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item
Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about items shared among groups. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
group | Model | Optional | Expand Deletes an existing user group — response body — groups item The group sharing the item. |
shared | string | Optional | How the item is shared. One of: - `not_shared`: The item is not shared. - `shared_to`: The item is shared. |
Referenced models: Locks a template — response body — error Details, Deletes an existing user group — response body — groups item
Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a shared item. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
shared | string | Optional | How the item is shared. One of: - `not_shared` - `shared_to` - `shared_from` - `shared_to_and_from` |
user | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner The user whose sharing information is being requested. |
Referenced models: Locks a template — response body — error Details, Gets a specific template associated with a specified account — response body — owner
Reserved: Gets the shared item status for one or more users — response body — shared Access item templates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about shared templates. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
owner | Model | Optional | Expand Gets a specific template associated with a specified account — response body — owner Information about the user who owns the template. |
password | string | Optional | The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests. |
shared | string | Optional | How the template is shared. One of: - `not_shared` - `shared_to` |
sharedGroups | array | Optional | List of groups that share the template. |
sharedGroups[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item |
sharedUsers | array | Optional | List of users that share the template. |
sharedUsers[] | Model | Each item | Expand Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item |
templateId | string | Optional | The unique identifier of the template. If this is not provided, Docusign will generate a value. |
templateName | string | Optional | The name of the shared template. |
Referenced models: Locks a template — response body — error Details, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Groups item, Gets a specific template associated with a specified account — response body — owner, Reserved: Gets the shared item status for one or more users — response body — shared Access item folders item shared Users item
Reserved: Purchase additional envelopes — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | string | Optional | The total amount of the purchase. |
appName | string | Optional | The AppName of the client application. |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the purchase. |
platform | string | Optional | The Platform of the client application |
productId | string | Optional | The Product ID from the AppStore. |
quantity | string | Optional | The quantity of envelopes to add to the account. |
receiptData | string | Optional | The encrypted Base64 encoded receipt data. |
storeName | string | Optional | The name of the AppStore. |
transactionId | string | Optional | Specifies the Transaction ID from the AppStore. |
Retrieves a billing invoice — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about a billing invoice. |
amount | string | Optional | The total amount of the purchase. |
balance | string | Optional | Reserved for Docusign. |
dueDate | string | Optional | Reserved for Docusign. |
invoiceId | string | Optional | Reserved for Docusign. |
invoiceItems | array | Optional | Reserved for Docusign. |
invoiceItems[] | Model | Each item | Expand Retrieves a billing invoice — response body — invoice Items item |
invoiceNumber | string | Optional | Reserved for Docusign. |
invoiceUri | string | Optional | Contains a URI for an endpoint that you can use to retrieve invoice information. |
nonTaxableAmount | string | Optional | |
pdfAvailable | string | Optional | |
taxableAmount | string | Optional |
Referenced models: Retrieves a billing invoice — response body — invoice Items item
Retrieves a billing invoice — response body — invoice Items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about an item on a billing invoice. |
chargeAmount | string | Optional | Reserved for Docusign. |
chargeName | string | Optional | Reserved for Docusign. |
invoiceItemId | string | Optional | Reserved for Docusign. |
quantity | string | Optional | The quantity of envelopes to add to the account. |
taxAmount | string | Optional | |
taxExemptAmount | string | Optional | |
unitPrice | string | Optional | Reserved for Docusign. |
Retrieves the HTML definition used to generate a dynamically sized responsive document — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
htmlDefinitions | array | Optional | Holds the properties that define how to generate the responsive-formatted HTML for the document. |
htmlDefinitions[] | Model | Each item | Expand Retrieves the HTML definition used to generate a dynamically sized responsive document — response body — html Definitions item |
Referenced models: Retrieves the HTML definition used to generate a dynamically sized responsive document — response body — html Definitions item
Retrieves the HTML definition used to generate a dynamically sized responsive document — response body — html Definitions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
documentId | string | Optional | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. |
documentIdGuid | string | Optional | The GUID of the document. |
htmlDefinition | Model | Optional | Expand Gets a specific template associated with a specified account — response body — documents item html Definition Defines how to generate the responsive-formatted HTML for the document. |
Referenced models: Gets a specific template associated with a specified account — response body — documents item html Definition
Retrieves the Identity Verification workflows available to an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
identityVerification | array | Optional | Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/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](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) 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). |
identityVerification[] | Model | Each item | Expand Gets account settings information — response body — identity Verification item |
Referenced models: Gets account settings information — response body — identity Verification item
Retrieves the account information for the specified account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains account Information. |
accountIdGuid | string | Optional | The GUID associated with the account ID. |
accountName | string | Optional | The name of the current account. |
accountSettings | Model | Optional | Expand Gets account settings information — response body The list of account settings accountsettings that determine the features available for the account. Note that some features are determined by the plan used to create the account and cannot be overridden. |
allowTransactionRooms | string | Optional | When **true,** the transaction rooms feature exposed through the Workspaces API is enabled. |
billingPeriodDaysRemaining | string | Optional | Number of days remaining in the current billing period. |
billingPeriodEndDate | string | Optional | The billing period end date in UTC timedate format. |
billingPeriodEnvelopesAllowed | string | Optional | The number of envelopes that can be sent in the current billing period (can be unlimited). |
billingPeriodEnvelopesSent | string | Optional | The number of envelopes that have been sent in the current billing period. |
billingPeriodStartDate | string | Optional | The billing period start date in UTC timedate format. |
billingProfile | string | Optional | Reserved for Docusign. |
brands | Model | Optional | Expand Gets a list of brands — response body A list of brands. |
canUpgrade | string | Optional | When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response. |
connectPermission | string | Optional | Value is "full" when Connect is enabled for this account. |
createdDate | string | Optional | The creation date of the account in UTC timedate format. |
currencyCode | string | Optional | Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account. |
currentPlanId | string | Optional | ID of the plan used to create this account. |
displayApplianceStartUrl | string | Optional | |
displayApplianceUrl | string | Optional | |
distributorCode | string | Optional | The code that identifies the billing plan groups and plans for the new account. |
docuSignLandingUrl | string | Optional | URL of the landing page used to create the account. |
dssValues | object | Optional | Additional keys: see wildcard field |
dssValues.* | string | Additional keys | |
envelopeSendingBlocked | string | Optional | When **true,** the ability to send envelopes is blocked. When **false,** envelopes can be sent. |
envelopeUnitPrice | string | Optional | The price of sending an envelope, represented in the account's local currency. |
externalAccountId | string | Optional | The Account ID displayed on the user's Account page. |
forgottenPasswordQuestionsCount | string | Optional | A complex element that contains up to four Question/Answer pairs for forgotten password information for a user. |
freeEnvelopeSendsRemainingForAdvancedDocGen | JSON | Optional | |
freeEnvelopeSendsRemainingForAdvancedDocGen (anyOf 1) | integer | Alternative | Format: int32 |
freeEnvelopeSendsRemainingForAdvancedDocGen (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
isDowngrade | string | Optional | When **true,** the account has been downgraded from a premium account type. Otherwise **false.** |
isFreeToTrialEligible | string | Optional | |
paymentMethod | string | Optional | The payment method used for the billing plan. Valid values are: - `NotSupported` - `CreditCard` - `PurchaseOrder` - `Premium` - `Freemium` - `FreeTrial` - `AppStore` - `DigitalExternal` - `DirectDebit` |
planClassification | string | Optional | Identifies the type of plan. Examples include: - `business` - `corporate` - `enterprise` - `free` |
planEndDate | string | Optional | The date that the current plan will end. |
planName | string | Optional | The name of the Billing Plan. |
planStartDate | string | Optional | The date that the Account started using the current plan. |
recipientDomains | array | Optional | |
recipientDomains[] | Model | Each item | Expand Retrieves the account information for the specified account — response body — recipient Domains item |
seatsAllowed | string | Optional | The number of active users the account can have at one time. |
seatsInUse | string | Optional | The number of users currently active on the account. |
status21CFRPart11 | string | Optional | The status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy. |
suspensionDate | string | Optional | The date on which the account was suspended. |
suspensionStatus | string | Optional | Indicates whether the account is currently suspended. |
useDisplayAppliance | boolean | Optional |
Referenced models: Gets a list of brands — response body, Gets account settings information — response body, Retrieves the account information for the specified account — response body — recipient Domains item
Retrieves the account information for the specified account — response body — recipient Domains item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
active | string | Optional | |
domainCode | string | Optional | |
domainName | string | Optional | |
recipientDomainId | string | Optional |
Retrieves the account provisioning information for the account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
defaultConnectionId | string | Optional | |
defaultPlanId | string | Optional | |
distributorCode | string | Optional | The code that identifies the billing plan groups and plans for the new account. |
distributorPassword | string | Optional | The password for the `distributorCode`. |
passwordRuleText | string | Optional | |
planPromotionText | string | Optional | |
purchaseOrderOrPromAllowed | string | Optional |
Retrieves the available REST API versions — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
buildBranch | string | Optional | Reserved for Docusign. |
buildBranchDeployedDateTime | string | Optional | Reserved for Docusign. |
buildSHA | string | Optional | Reserved for Docusign. |
buildVersion | string | Optional | Reserved for Docusign. |
linkedSites | array | Optional | |
linkedSites[] | string | Each item | |
serviceVersions | array | Optional | |
serviceVersions[] | Model | Each item | Expand Retrieves the available REST API versions — response body — service Versions item |
Referenced models: Retrieves the available REST API versions — response body — service Versions item
Retrieves the available REST API versions — response body — service Versions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
version | string | Optional | The version of the rest API. |
versionUrl | string | Optional |
Retrieves the list of users for the specified account You can filter the users list to get specific users — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains a list of account users. |
endPosition | string | Optional | The last index position in the result set. |
nextUri | string | Optional | The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. |
previousUri | string | Optional | The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. |
resultSetSize | string | Optional | The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. |
users | array | Optional | User management information. |
users[] | Model | Each item | Expand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body |
Referenced models: Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
Retrieves the user profile for a specified user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | Model | Optional | Expand Get credit card information — response body — address The user's address. |
authenticationMethods | array | Optional | Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation. |
authenticationMethods[] | Model | Each item | Expand Retrieves the user profile for a specified user — response body — authentication Methods item |
companyName | string | Optional | The name of the user's company. |
displayOrganizationInfo | string | Optional | When **true,** the user's company and title information display on the ID card. |
displayPersonalInfo | string | Optional | When **true,** the user's address and phone number display on the ID card. |
displayProfile | string | Optional | When **true,** the user's ID card can be viewed from signed documents and envelope history. |
displayUsageHistory | string | Optional | When **true,** the user's usage information displays on the ID card. |
profileImageUri | string | Optional | The URL for retrieving the user's profile image. |
title | string | Optional | The title of the user. |
usageHistory | Model | Optional | Expand Retrieves the user profile for a specified user — response body — usage History A complex element consisting of: - `lastSentDateTime`: The date and time the user last sent an envelope. - `lastSignedDateTime`: The date and time the user last signed an envelope. - `sentCount`: The number of envelopes the user has sent. - `signedCount`: The number of envelopes the user has signed. |
userDetails | Model | Optional | Expand Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body |
userProfileLastModifiedDate | string | Optional | The date and time that the user's profile was last modified. |
Referenced models: Get credit card information — response body — address, Retrieves the user profile for a specified user — response body — authentication Methods item, Retrieves the user profile for a specified user — response body — usage History, Gets the user information for a specified user using a user Id (GUID) To find a user based on their email address, use the list endpoint — response body
Retrieves the user profile for a specified user — response body — authentication Methods item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains information about the method used for authentication. |
authenticationType | string | Optional | Indicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth. |
lastProvider | string | Optional | The last provider that authenticated the user. |
lastTimestamp | string | Optional | The data and time the user last used the authentication method. |
totalCount | string | Optional | The number of times the authentication method was used. |
Retrieves the user profile for a specified user — response body — usage History
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element consisting of: * lastSentDateTime - the date and time the user last sent an envelope. * lastSignedDateTime - the date and time the user last signed an envelope. * sentCount - the number of envelopes the user has sent. * signedCount - the number of envelopes the user has signed. |
lastSentDateTime | string | Optional | The date and time the user last sent an envelope. |
lastSignedDateTime | string | Optional | The date and time the user last signed an envelope. |
sentCount | string | Optional | The number of envelopes the user has sent. |
signedCount | string | Optional | The number of envelopes the user has signed. |
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
returnUrl | string | Optional | **Required** Identifies the return point after sending the envelope. Docusign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are: * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action). |
settings | Model | Optional | Expand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings Sets the UX for the resulting embedded view. |
viewAccess | string | Optional | **Required** . Set to `envelope` |
Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings
Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
backButtonAction | string | Optional | Sets the behavior of the back button when clicked. Valid values: * `previousPage`: Navigate to browser's previous page * `redirect`: Redirect to the `returnUrl` specified in the request |
documentSettings | Model | Optional | Expand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings document Settings Sets the custom document settings. |
envelopeCustomFieldSettings | Model | Optional | Expand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings envelope Custom Field Settings Reserved for Docusign. |
lockToken | string | Optional | If your app will modify the envelope after the user finishes editing the envelope, create and use a [lock token](/docs/esign-rest-api/reference/envelopes/envelopelocks/create/) for this attribute. Remember to delete the lock token after your app has finished its envelope modifications. |
recipientSettings | Model | Optional | Expand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings recipient Settings |
sendButtonAction | string | Optional | Sets the behavior of the send button when clicked. Valid values: * `send`: send the envelope and redirect with query parameter `event=Send` (default) * `redirect`: Change the Tagger page's button text to 'Continue'; when clicked, redirect to the `returnUrl` with query parameter `event=Save`. Set `showBackButton` to `false` and `startingScreen` to `Tagger`. |
showAdvancedOptions | string | Optional | Reserved for Docusign. |
showBackButton | string | Optional | Determines whether the Tagger's back button is shown. Valid values: * `true`: The back button is shown. This is the default value. * `false`: Prevents access to the Prepare screen by hiding the back button. |
showDiscardAction | string | Optional | When **true,** the Discard option is shown in the Actions menu. When **false,** the Discard option is not shown. The default value is **true.** |
showHeaderActions | string | Optional | Determines whether the Actions menu displays advanced actions. Valid values: * `true`: The Actions menu shows all options, including editing the message, recipients, documents, and advanced options. This is the default value. * `false`: The Actions menu will only show Save, Close, and Discard. To limit the user to tagging only, use this value and set `startingScreen` to `Tagger` and `showBackButton` to `false`. |
showSignNow | string | Optional | |
startingScreen | string | Optional | Determines the starting screen for the sender view. Valid values: * `Prepare` (default) * `Tagger` |
taggerSettings | Model | Optional | Expand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings Sets the custom tagger settings. |
templateSettings | Model | Optional | Expand Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings template Settings Reserved for Docusign. |
Referenced models: Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings document Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings envelope Custom Field Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings recipient Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings tagger Settings, Returns a URL to the edit view UI Use before an envelope has been sent — request body — body settings template Settings