AccountPermissionProfiles: create

This method creates a new permission profile for an account.

Request

HTTP request

POST /v2.1/accounts/{accountId}/permission_profiles

Parameters

Parameter Name	Value	Description
Path Parameters
accountId	string	The external account number (int) or account ID GUID.
Optional Query Parameters
include	string	A comma-separated list of additional properties to return in the response. The only valid value for this request is `metadata`, which returns metadata indicating whether the properties associated with the account permission profile are editable.

Request Body

AccountPermissionProfiles

Responses

Code	Description	Reference
201	Successful response.	AccountPermissionProfiles
400	Error encountered.	errorDetails

Code

Description

Reference

201

Successful response.

AccountPermissionProfiles

400

Error encountered.

errorDetails

SDK Method

Accounts::createPermissionProfile

Definitions

accountRoleSettings

This object defines account permissions for users who are associated with the account permission profile.
`allowAccountManagement`	string	When true, users have full administrative access to the account.
`allowAccountManagementMetadata`	settingsMetadata	Metadata that indicates whether the `allowAccountManagement` property is editable.
`allowApiAccess`	string	When true, users can manage documents by using the API.
`allowApiAccessMetadata`	settingsMetadata	Metadata that indicates whether the `allowApiAccess` property is editable.
`allowApiAccessToAccount`	string	When true, users can access the account by using the eSignature API.
`allowApiAccessToAccountMetadata`	settingsMetadata	Metadata that indicates whether the `allowApiAccessToAccount` property is editable.
`allowApiSendingOnBehalfOfOthers`	string	When true, users can send envelopes on behalf of others.
`allowApiSendingOnBehalfOfOthersMetadata`	settingsMetadata	Metadata that indicates whether the `allowApiSendingOnBehalfOfOthers` property is editable.
`allowApiSequentialSigning`	string	When true, users may specify sequential signing recipients when they send documents by using the API.
`allowApiSequentialSigningMetadata`	settingsMetadata	Metadata that indicates whether the `allowApiSequentialSigning` property is editable.
`allowAutoTagging`	string
`allowAutoTaggingMetadata`	settingsMetadata
`allowBulkSending`	string	When true, bulk sending is enabled for users.
`allowBulkSendingMetadata`	settingsMetadata	Metadata that indicates whether the `allowBulkSending` property is editable.
`allowDocuSignDesktopClient`	string	When true, the DocuSign Desktop Client is enabled for users.
`allowDocuSignDesktopClientMetadata`	settingsMetadata	Metadata that indicates whether the `allowDocuSignDesktopClient` property is editable.
`allowedAddressBookAccess`	string	Specifies the level of access that users have to the account's address book. Valid values are: `personal` `useShared` `usePersonalAndShared` `personalAndShared`
`allowedAddressBookAccessMetadata`	settingsMetadata	Metadata that indicates whether the `allowedAddressBookAccess` property is editable.
`allowedClickwrapsAccess`	string
`allowedClickwrapsAccessMetadata`	settingsMetadata
`allowedTemplateAccess`	string	Specifies the level of access that users have to account templates. Valid values are: `none` `use` `create` `share`
`allowedTemplateAccessMetadata`	settingsMetadata	Metadata that indicates whether the `allowedTemplateAccess` property is editable.
`allowedToBeEnvelopeTransferRecipient`	string	When true, users can be recipients of envelopes transferred to them by administrators of other accounts.
`allowedToBeEnvelopeTransferRecipientMetadata`	settingsMetadata	Metadata that indicates whether the `allowedToBeEnvelopeTransferRecipient` property is editable.
`allowEnvelopeSending`	string	When true, users can send envelopes.
`allowEnvelopeSendingMetadata`	settingsMetadata	Metadata that indicates whether the `allowEnvelopeSending` property is editable.
`allowESealRecipients`	string	When true, users can add electronic seal (eSeal) recipients.
`allowESealRecipientsMetadata`	settingsMetadata	Metadata that indicates whether the `allowESealRecipients` property is editable.
`allowPowerFormsAdminToAccessAllPowerFormEnvelopes`	string	When true, PowerForm Administrators can access all of the PowerForm envelopes associated with the account.
`allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata`	settingsMetadata	Metadata that indicates whether the `allowPowerFormsAdminToAccessAllPowerFormEnvelopes` property is editable.
`allowSendersToSetRecipientEmailLanguage`	string	When true, senders can set the language of the email that is sent to recipients.
`allowSendersToSetRecipientEmailLanguageMetadata`	settingsMetadata	Metadata that indicates whether the `allowSendersToSetRecipientEmailLanguage` property is editable.
`allowSignerAttachments`	string	When true, users can add requests for attachments from signers.
`allowSignerAttachmentsMetadata`	settingsMetadata	Metadata that indicates whether the `allowSignerAttachments` property is editable.
`allowSupplementalDocuments`	string	When true, senders can include supplemental documents.
`allowSupplementalDocumentsMetadata`	settingsMetadata	Metadata that indicates whether the `allowSupplementalDocuments` property is editable.
`allowTaggingInSendAndCorrect`	string	When true, the tagger palette is visible during the sending and correct flows and users can add tabs to documents.
`allowTaggingInSendAndCorrectMetadata`	settingsMetadata	Metadata that indicates whether the `allowTaggingInSendAndCorrect` property is editable.
`allowVaulting`	string	Reserved for DocuSign.
`allowVaultingMetadata`	settingsMetadata	Reserved for DocuSign.
`allowWetSigningOverride`	string	When true, users can override the default account setting that controls whether recipients can sign documents on paper. The option to overrride this setting occurs during the sending process on a per-envelope basis.
`allowWetSigningOverrideMetadata`	settingsMetadata	Metadata that indicates whether the `allowWetSigningOverride` property is editable.
`canCreateWorkspaces`	string	Reserved for DocuSign.
`canCreateWorkspacesMetadata`	settingsMetadata	Reserved for DocuSign.
`disableDocumentUpload`	string	When true, users cannot upload documents.
`disableDocumentUploadMetadata`	settingsMetadata	Metadata that indicates whether the `disableDocumentUpload` property is editable.
`disableOtherActions`	string	When true, users can access the Other Actions menu.
`disableOtherActionsMetadata`	settingsMetadata	Metadata that indicates whether the `disableOtherActions` property is editable.
`enableApiRequestLogging`	string	When true, API request logging is enabled. Note: Logging limits apply.
`enableApiRequestLoggingMetadata`	settingsMetadata	Metadata that indicates whether the `enableApiRequestLogging` property is editable.
`enableRecipientViewingNotifications`	string	When true, senders are notified when recipients view the documents that they send.
`enableRecipientViewingNotificationsMetadata`	settingsMetadata	Metadata that indicates whether the `enableRecipientViewingNotifications` property is editable.
`enableSequentialSigningInterface`	string	When true, the sequential signing user interface is enabled.
`enableSequentialSigningInterfaceMetadata`	settingsMetadata	Metadata that indicates whether the `enableSequentialSigningInterface` property is editable.
`enableTransactionPointIntegration`	string	Reserved for DocuSign.
`enableTransactionPointIntegrationMetadata`	settingsMetadata	Reserved for DocuSign.
`powerFormRole`	string	The PowerForms rights associated with the account permission profile. Valid values are: `none` `user` `admin`
`powerFormRoleMetadata`	settingsMetadata	Metadata that indicates whether the `powerFormRole` property is editable.
`receiveCompletedSelfSignedDocumentsAsEmailLinks`	string	When true, senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments.
`receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata`	settingsMetadata	Metadata that indicates whether the `receiveCompletedSelfSignedDocumentsAsEmailLinks` property is editable.
`signingUiVersionMetadata`	settingsMetadata	Reserved for DocuSign.
`supplementalDocumentsMustAccept`	string	When true, senders can require recipients to accept supplemental documents.
`supplementalDocumentsMustAcceptMetadata`	settingsMetadata	Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable.
`supplementalDocumentsMustRead`	string	When true, senders can require recipients to read supplemental documents.
`supplementalDocumentsMustReadMetadata`	settingsMetadata	Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable.
`supplementalDocumentsMustView`	string	When true, users can require recipients to view supplemental documents.
`supplementalDocumentsMustViewMetadata`	settingsMetadata	Metadata that indicates whether the `supplementalDocumentsMustView` property is editable.
`useNewDocuSignExperienceInterface`	string	Reserved for DocuSign.
`useNewDocuSignExperienceInterfaceMetadata`	settingsMetadata	Reserved for DocuSign.
`useNewSendingInterface`	string	Reserved for DocuSign.
`useNewSendingInterfaceMetadata`	settingsMetadata	Reserved for DocuSign.
`vaultingMode`	string	Reserved for DocuSign.
`vaultingModeMetadata`	settingsMetadata	Reserved for DocuSign.

addressInformation

Contains address information.
`address1`	string	The first line of the user's address. Maximum length: 100 characters.
`address2`	string	The second line of the user's address. Maximum length: 100 characters.
`city`	string	The user's city.
`country`	string	The user's country.
`fax`	string	A fax number associated with the address, if one is available.
`phone`	string	A phone number associated with the address.
`postalCode`	string	The user's postal code.
`stateOrProvince`	string	The user's state or province.

connectUserObject


`configurationtype`	string	The type of custom Connect configuration being accessed.
`connectId`	string	The ID of the custom Connect configuration being accessed.
`enabled`	string	Boolean value that indicates whether the custom Connect configuration is enabled or not.
`hasAccess`	string
`senderSearchableItems`	[array]

errorDetails

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

errorCode

string

The code associated with the error condition.

message

string

A brief message describing the error condition.

forgottenPasswordInformation

A complex element that has up to four Question/Answer pairs for forgotten password information.
`forgottenPasswordAnswer1`	string	The answer to the first forgotten password challenge question.
`forgottenPasswordAnswer2`	string	The answer to the second forgotten password challenge question.
`forgottenPasswordAnswer3`	string	The answer to the third forgotten password challenge question.
`forgottenPasswordAnswer4`	string	The answer to the fourth forgotten password challenge question.
`forgottenPasswordQuestion1`	string	The first challenge question presented to a user who has forgotten their password.
`forgottenPasswordQuestion2`	string	The second challenge question presented to a user who has forgotten their password.
`forgottenPasswordQuestion3`	string	The third challenge question presented to a user who has forgotten their password.
`forgottenPasswordQuestion4`	string	The fourth challenge question presented to a user who has forgotten their password.

group

This object contains information about a group.
`errorDetails`	errorDetails	This object describes errors that occur. It is only valid for responses and ignored in requests.
`groupId`	string	The DocuSign group ID for the group.
`groupName`	string	The name of the group.
`groupType`	string	The group type. Possible values include: `adminstrators` `everyone` `customGroup` `sharedSigningGroup`
`permissionProfileId`	string	The ID of the permission profile associated with the group. Possible values include: `2301416` (for the `DocuSign Viewer` profile) `2301415` (for the `DocuSign Sender` profile) `2301414` (for the `Account Administrator` profile)
`users`	[userInfo]	A list of the users in the group.
`usersCount`	string	The total number of users in the group.

localePolicy


`addressFormat`	string
`addressFormatMetadata`	settingsMetadata
`allowRegion`	string
`calendarType`	string
`calendarTypeMetadata`	settingsMetadata
`cultureName`	string
`cultureNameMetadata`	settingsMetadata
`currencyCode`	string	The currency code for the account, based on the ISO 4217 currency code.
`currencyCodeMetadata`	settingsMetadata	Metadata that indicates whether the `currencyCode` property is editable.
`currencyNegativeFormat`	string
`currencyNegativeFormatMetadata`	settingsMetadata
`currencyPositiveFormat`	string
`currencyPositiveFormatMetadata`	settingsMetadata
`customDateFormat`	string
`customSignDateFormat`	string
`customSignTimeFormat`	string
`customTimeFormat`	string
`dateFormat`	string
`dateFormatMetadata`	settingsMetadata
`effectiveAddressFormat`	string
`effectiveCalendarType`	string
`effectiveCurrencyCode`	string
`effectiveCurrencyNegativeFormat`	string
`effectiveCurrencyPositiveFormat`	string
`effectiveCustomDateFormat`	string
`effectiveCustomTimeFormat`	string
`effectiveDateFormat`	string
`effectiveInitialFormat`	string
`effectiveNameFormat`	string
`effectiveTimeFormat`	string
`effectiveTimeZone`	string
`initialFormat`	string
`initialFormatMetadata`	settingsMetadata
`nameFormat`	string
`nameFormatMetadata`	settingsMetadata
`signDateFormat`	string	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`
`signDateFormatMetadata`	settingsMetadata	Metadata that indicates whether the `signDateFormat` property is editable.
`signTimeFormat`	string	The format for the signature time. Valid values are: `none` `HH:mm` `h:mm` `HH:mm:ss` `h:mm:ss`
`signTimeFormatMetadata`	settingsMetadata	Metadata that indicates whether the `signTimeFormat` property is editable.
`timeFormat`	string
`timeFormatMetadata`	settingsMetadata
`timeZone`	string
`timeZoneMetadata`	settingsMetadata

nameValue


`errorDetails`	errorDetails	This object describes errors that occur. It is only valid for responses and ignored in requests.
`name`	string	The name of the item.
`originalValue`	string	The initial value of the item.
`value`	string	The current value of the item.

sealIdentifier


`sealDisplayName`	string
`sealName`	string

senderEmailNotifications

Contains the settings for the email notifications that senders receive about the envelopes that they send.
`changedSigner`	string	When set to true, the sender receives an email notification if the signer changes.
`commentsOnlyPrivateAndMention`	string	When set to true, the user receives only comments that mention their own user name.
`commentsReceiveAll`	string	When set to true, the user receives all comments.
`deliveryFailed`	string	When set to true, the sender receives an email notification if envelope delivery fails.
`envelopeComplete`	string	When set to true, the user receives an email notification when the envelope has been completed.
`offlineSigningFailed`	string	When set to true, the user receives an email notification if offline signing failed.
`purgeDocuments`	string	When set to true, the user receives an email notification when a document purge occurs.
`recipientViewed`	string	When set to true, the sender receives notification that a recipient viewed the envelope.
`senderEnvelopeDeclined`	string	When set to true, the sender receives notification that the envelope was declined.
`withdrawnConsent`	string	When set to true, the user receives an email notification if consent is withdrawn.

settingsMetadata

Metadata that indicates whether a property is editable and describes setting-specific options.
`is21CFRPart11`	string	When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
`options`	[array]	An array of option strings supported by this setting.
`rights`	string	Indicates whether the property is editable. Valid values are: `editable` `read_only`
`uiHint`	string	Reserved for DocuSign.
`uiOrder`	string	Reserved for DocuSign.
`uiType`	string	Reserved for DocuSign.

signerEmailNotifications

An array of email notifications that specifies the email the user receives when they are a sender. 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 sender email notification settings when the user is created.
`agentNotification`	string	When set to true, the user receives agent notification emails.
`carbonCopyNotification`	string	When set to true, the user receives notifications of carbon copy deliveries.
`certifiedDeliveryNotification`	string	When set to true, the user receives notifications of certified deliveries.
`commentsOnlyPrivateAndMention`	string	When set to true, the user receives only comments that mention their own user name.
`commentsReceiveAll`	string	When set to true, the user receives all comments.
`documentMarkupActivation`	string	When set to true, the user receives notification that document markup has been activated.
`envelopeActivation`	string	When set to true, the user receives notification that the envelope has been activated.
`envelopeComplete`	string	When set to true, the user receives an email notification when the envelope has been completed.
`envelopeCorrected`	string	When set to true, the user receives notification that the envelope has been corrected.
`envelopeDeclined`	string	When set to true, the user receives notification that the envelope has been declined.
`envelopeVoided`	string	When set to true, the user receives notification that the envelope has been voided.
`faxReceived`	string	Reserved for DocuSign.
`offlineSigningFailed`	string	When set to true, the user receives an email notification if offline signing failed.
`purgeDocuments`	string	When set to true, the user receives an email notification when a document purge occurs.
`reassignedSigner`	string	When set to true, the user receives notification that the envelope has been reassigned.
`whenSigningGroupMember`	string	When set to true, the user receives notification that he or she is a member of the signing group.

userAccountManagementGranularInformation

Describes which account management capabilities a user has.
`canManageAccountSecuritySettings`	string	True if the user can manage account security settings.
`canManageAccountSecuritySettingsMetadata`	settingsMetadata
`canManageAccountSettings`	string	True if the user can manage account settings.
`canManageAccountSettingsMetadata`	settingsMetadata
`canManageAdmins`	string	True if the user can manage administrators.
`canManageAdminsMetadata`	settingsMetadata	Metadata that indicates whether the `canManageAdmins` property is editable.
`canManageReporting`	string	True if the user can manage reporting.
`canManageReportingMetadata`	settingsMetadata
`canManageSharing`	string	True if the user can manage sharing.
`canManageSharingMetadata`	settingsMetadata	Metadata that indicates whether the `canManageSharing` property is editable.
`canManageSigningGroups`	string	True if the user can manage signing groups.
`canManageSigningGroupsMetadata`	settingsMetadata
`canManageUsers`	string	True if the user can manage users.
`canManageUsersMetadata`	settingsMetadata	Metadata that indicates whether the `canManageUsers` property is editable.

userInfo


`accountId`	string	The external account number (int) or account ID GUID.
`accountName`	string	The name of the account associated with the current workspace user.
`activationAccessCode`	string	Access code provided to the user to activate the account.
`email`	string
`errorDetails`	errorDetails	This object describes errors that occur. It is only valid for responses and ignored in requests.
`loginStatus`	string	Boolean value that indicates whether the user is currently logged in or not.
`membershipId`	string	The user's membership ID.
`sendActivationEmail`	string	When set to true, specifies that an activation email be sent to the user.
`uri`	string	A URI containing the user ID.
`userId`	string	The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.
`userName`	string	The name of the user.
`userStatus`	string	Status of the user's account. One of: `ActivationRequired` `ActivationSent` `Active` `Closed` `Disabled`
`userType`	string	The type of user, for example `CompanyUser`.

userSettingsInformation

Data that describes 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)
`accountManagementGranular`	userAccountManagementGranularInformation	Describes which account management capabilities a user has.
`adminOnly`	string	Reserved for DocuSign.
`adminOnlyMetadata`	settingsMetadata	Reserved for DocuSign.
`allowAutoTagging`	string
`allowEnvelopeTransferTo`	string	Boolean value that indicates whether the user can participate in envelope transfers on the account.
`allowEnvelopeTransferToMetadata`	settingsMetadata	Reserved for DocuSign.
`allowEsealRecipients`	string
`allowEsealRecipientsMetadata`	settingsMetadata
`allowPowerFormsAdminToAccessAllPowerFormEnvelope`	string
`allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata`	settingsMetadata
`allowRecipientLanguageSelection`	string	When true, this user can set the language used in the standard email format for a recipient when creating an envelope.
`allowRecipientLanguageSelectionMetadata`	settingsMetadata	Metadata for allowRecipientLanguageSelection.
`allowSendOnBehalfOf`	string	When true, this user can send envelopes "on behalf of" other users through the API.
`allowSendOnBehalfOfMetadata`	settingsMetadata	Metadata for allowSendOnBehalfOf.
`allowSupplementalDocuments`	string	When true, this user can include supplemental documents.
`allowSupplementalDocumentsMetadata`	settingsMetadata	Metadata that indicates whether the `allowSupplementalDocuments` property is editable.
`anchorTagVersionedPlacementEnabled`	string	Valid values are: `system_default` `off` `on`
`apiAccountWideAccess`	string	When true, indicates that this user can send envelope-specific API requests on the account.
`apiAccountWideAccessMetadata`	settingsMetadata	Metadata for apiAccountWideAccess.
`apiCanExportAC`	string	When true, this user can export authoritative copy for the account.
`apiCanExportACMetadata`	settingsMetadata
`bulkSend`	string	When true, this user can use the bulk send feature for the account.
`bulkSendMetadata`	settingsMetadata	Metadata that indicates whether the `bulkSend` property is editable.
`canChargeAccount`	string	Reserved for DocuSign.
`canChargeAccountMetadata`	settingsMetadata	Reserved for DocuSign.
`canEditSharedAddressbook`	string	When true, this user can edit the shared address book for the account.
`canEditSharedAddressbookMetadata`	settingsMetadata
`canLockEnvelopes`	string
`canLockEnvelopesMetadata`	settingsMetadata
`canManageAccount`	string	When true, this user is an administrator for the account.
`canManageAccountMetadata`	settingsMetadata
`canManageDistributor`	string	Reserved for DocuSign.
`canManageDistributorMetadata`	settingsMetadata
`canManageTemplates`	string	When true, this user can manage templates for the account.
`canManageTemplatesMetadata`	settingsMetadata
`canSendAPIRequests`	string	When true, this user can send API requests on the account.
`canSendAPIRequestsMetadata`	settingsMetadata
`canSendEnvelope`	string	When true, this user can send envelopes on the account.
`canSendEnvelopeMetadata`	settingsMetadata
`canSignEnvelope`	string	When true, this user can sign envelopes.
`canSignEnvelopeMetadata`	settingsMetadata
`canUseScratchpad`	string
`canUseScratchpadMetadata`	settingsMetadata
`canUseSmartContracts`	string
`canUseSmartContractsMetadata`	settingsMetadata
`disableDocumentUpload`	string	When true, this user is prohibited from uploading documents during sending.
`disableDocumentUploadMetadata`	settingsMetadata	Metadata that indicates whether the `disableDocumentUpload` property is editable.
`disableOtherActions`	string	When true, this user can access the Other Actions menu.
`disableOtherActionsMetadata`	settingsMetadata	Metadata that indicates whether the `disableOtherActions` property is editable.
`enableDSPro`	string	Reserved for DocuSign.
`enableDSProMetadata`	settingsMetadata	Metadata that indicates whether the `enableDSPro` property is editable.
`enableSequentialSigningAPI`	string	When true, the account can define the routing order of recipients for envelopes sent using the DocuSign API.
`enableSequentialSigningAPIMetadata`	settingsMetadata	Metadata that indicates whether the `enableSequentialSigningAPI` property is editable.
`enableSequentialSigningUI`	string	When true, the account can define the routing order of recipients for envelopes sent using the DocuSign application.
`enableSequentialSigningUIMetadata`	settingsMetadata	Metadata that indicates whether the `enableSequentialSigningUI` property is editable.
`enableSignerAttachments`	string	When true, this user can use the signing attachments feature.
`enableSignerAttachmentsMetadata`	settingsMetadata	Metadata that indicates whether the `enableSignerAttachments` property is editable.
`enableSignOnPaperOverride`	string	When true, this user can override the Sign on Paper account setting, which specifies whether signers can sign documents on paper as an option to signing electronically.
`enableSignOnPaperOverrideMetadata`	settingsMetadata	Metadata that indicates whether the `enableSignOnPaperOverride` property is editable.
`enableTransactionPoint`	string	Reserved for DocuSign.
`enableTransactionPointMetadata`	settingsMetadata	Metadata that indicates whether the `enableTransactionPoint` property is editable.
`enableVaulting`	string	When true, Vaulting is enabled for the account.
`enableVaultingMetadata`	settingsMetadata	Metadata that indicates whether the `enableVaulting` property is editable.
`expressSendOnly`	string
`locale`	string	The user's locale code: `zh_CN` `zh_TW` `nl` `en` `fr` `de` `it` `ja` `ko` `pt` `pt_BR` `ru` `es`
`localeMetadata`	settingsMetadata
`localePolicy`	localePolicy	Reserved for DocuSign.
`manageClickwrapsMode`	string
`manageClickwrapsModeMetadata`	settingsMetadata
`modifiedBy`	string	User ID (GUID) of the user who last modified this user record.
`modifiedByMetadata`	settingsMetadata
`modifiedDate`	string	Most recent date on which this user record was modified.
`modifiedDateMetadata`	settingsMetadata
`modifiedPage`	string	Note referencing the page that modified this user record.
`modifiedPageMetadata`	settingsMetadata
`newSendUI`	string	Reserved for DocuSign.
`newSendUIMetadata`	settingsMetadata
`powerFormMode`	string	Indicates the Power Form mode setting for the user: `none` `admin` `user`
`powerFormModeMetadata`	settingsMetadata
`recipientViewedNotification`	string	When true, this user receives notifications when envelopes are viewed.
`recipientViewedNotificationMetadata`	settingsMetadata
`sealIdentifiers`	[sealIdentifier]
`selfSignedRecipientEmailDocument`	string	Valid values are: `include_pdf` `include_link`
`selfSignedRecipientEmailDocumentMetadata`	settingsMetadata	Metadata that indicates whether the `selfSignedRecipientEmailDocument` property is editable.
`senderEmailNotifications`	senderEmailNotifications	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`	signerEmailNotifications	An array of email notifications that specifies the email the user receives when they are a sender. 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 sender email notification settings when the user is created.
`supplementalDocumentIncludeInDownload`	string	When true, this user gets supplemental documents when downloading documents.
`supplementalDocumentsMustAccept`	string	When true, this user must accept supplemental documents.
`supplementalDocumentsMustAcceptMetadata`	settingsMetadata	Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable.
`supplementalDocumentsMustRead`	string	When true, this user must read supplemental documents.
`supplementalDocumentsMustReadMetadata`	settingsMetadata	Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable.
`supplementalDocumentsMustView`	string	When true, this user must view supplemental documents.
`supplementalDocumentsMustViewMetadata`	settingsMetadata	Metadata that indicates whether the `supplementalDocumentsMustView` property is editable.
`templateActiveCreation`	string
`templateActiveCreationMetadata`	settingsMetadata
`templateApplyNotify`	string
`templateApplyNotifyMetadata`	settingsMetadata
`templateAutoMatching`	string
`templateAutoMatchingMetadata`	settingsMetadata
`templateMatchingSensitivity`	string	Percentage used when matching templates.
`templateMatchingSensitivityMetadata`	settingsMetadata
`templatePageLevelMatching`	string	When true, users see template matching functionality.
`templatePageLevelMatchingMetadata`	settingsMetadata
`timezoneDST`	string	When true, daylight savings time is in effect for this user's time zone.
`timezoneDSTMetadata`	settingsMetadata
`timezoneMask`	string
`timezoneMaskMetadata`	settingsMetadata
`timezoneOffset`	string	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`	settingsMetadata
`timezoneSendingPref`	string	Reserved for DocuSign.
`timezoneSendingPrefMetadata`	settingsMetadata
`timezoneSigningPref`	string	Reserved for DocuSign.
`timezoneSigningPrefMetadata`	settingsMetadata
`transactionPointSiteNameURL`	string	Reserved for DocuSign.
`transactionPointSiteNameURLMetadata`	settingsMetadata
`transactionPointUserName`	string	Reserved for DocuSign.
`transactionPointUserNameMetadata`	settingsMetadata
`vaultingMode`	string	Indicates the specified Vaulting mode: `none` `estored` `electronic_original`
`vaultingModeMetadata`	settingsMetadata	Metadata that indicates whether the `vaultingMode` property is editable.

Users

The Users resource enables you to create and manage account users.
`activationAccessCode`	string	The activation code a new user must enter when activating their account.
`company`	string	The name of the user's company.
`connectConfigurations`	[connectUserObject]	Object representing the user's custom Connect configuration.
`countryCode`	string	The three-letter code for the user's country.
`createdDateTime`	string	The UTC DateTime when the item was created.
`customSettings`	[nameValue]	The name/value pair information for the user custom setting.
`defaultAccountId`	string	The default account ID associated with the user.
`email`	string	The user's email address.
`enableConnectForUser`	string	Boolean value that specifies whether the user is enabled for updates from DocuSign Connect.
`errorDetails`	errorDetails	This object describes errors that occur. It is only valid for responses and ignored in requests.
`firstName`	string	The user's first name. Maximum Length: 50 characters.
`forgottenPasswordInfo`	forgottenPasswordInformation	A complex element containing up to four Question/Answer pairs for forgotten password information.
`groupList`	[group]	A list of the group information for groups to add the user to. Use UserGroups::listGroups to get information about groups. When setting a user's group, only the `groupId` is required.
`homeAddress`	addressInformation	The user's physical home address.
`initialsImageUri`	string	The URI for retrieving the image of the user's initials.
`isAdmin`	string	Determines if the feature set is actively set as part of the plan.
`isNAREnabled`	string
`jobTitle`	string	The user's job title.
`lastLogin`	string	The date and time when the user last logged in to the system.
`lastName`	string	The user's last name. Maximum Length: 50 characters.
`loginStatus`	string	Shows the current status of the user's password. Possible values are: password_reset password_active password_expired password_locked password_reset_failed
`middleName`	string	The user's middle name. Limit: 50 characters.
`password`	string	The user's password.
`passwordExpiration`	string	If password expiration is enabled, the date-time when the user's password expires.
`permissionProfileId`	string	The id of the permission profile associated with the user.
`permissionProfileName`	string	The name of the permission profile associated with the user.
`profileImageUri`	string	The URL for retrieving the user's profile image.
`sendActivationEmail`	string	When set to true, specifies that an activation email be sent to the user.
`sendActivationOnInvalidLogin`	string	When set to true, specifies that an additional activation email be sent if user's log on fails before the account is activated.
`signatureImageUri`	string	An endpoint URI that you can use to retrieve the user's signature image.
`subscribe`	string
`suffixName`	string	The suffix for the user's name, such as Jr, IV, PhD, etc. Limit: 50 characters.
`title`	string	The salutation for the user, such as Ms, Dr, Capt., etc. Limit: 10 characters.
`uri`	string	A URI containing the user ID.
`userAddedToAccountDateTime`	string	The date and time that the user was added to the account.
`userId`	string	The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing.
`userName`	string	The user's full name.
`userProfileLastModifiedDate`	string	The date and time that the user's profile was last modified.
`userSettings`	userSettingsInformation	The collection of settings representing the actions a user can perform. See userSettingsInformation for available settings.
`userStatus`	string	Status of the user's account. One of: `ActivationRequired` `ActivationSent` `Active` `Closed` `Disabled`
`userType`	string	The type of user, for example `CompanyUser`.
`workAddress`	addressInformation	The user's physical work address.

AccountPermissionProfiles

The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users.
`modifiedByUsername`	string	The username of the user who last modified the permission profile.
`modifiedDateTime`	string	The date and time when the permission profile was last modified.
`permissionProfileId`	string	The ID of the permission profile. Possible values include: `2301416` (for the `DocuSign Viewer` profile) `2301415` (for the `DocuSign Sender` profile) `2301414` (for the `Account Administrator` profile) In addition, any custom permission profiles associated with your account will have an automatically generated `permissionProfileId`.
`permissionProfileName`	string	The name of the account permission profile. Example: `Account Administrator`
`settings`	accountRoleSettings	This object specifies the permissions that are associated with the account permission profile.
`userCount`	string	The total number of users in the group associated with the account permission profile.
`users`	[Users]	A list of user objects containing information about the users who are associated with the account permission profile.

Examples

Generic JSON Request/Response

Request

{
  "permissionProfileId": "sample string 1",
  "permissionProfileName": "sample string 2",
  "users": [
    {
      "userName": "sample string 1",
      "userId": "sample string 2",
      "userType": "sample string 3",
      "isAdmin": "sample string 4",
      "userStatus": "sample string 5",
      "uri": "sample string 6",
      "email": "sample string 7",
      "password": "sample string 8",
      "title": "sample string 9",
      "createdDateTime": "sample string 10",
      "firstName": "sample string 11",
      "middleName": "sample string 12",
      "lastName": "sample string 13",
      "suffixName": "sample string 14",
      "permissionProfileId": "sample string 15",
      "permissionProfileName": "sample string 16",
      "countryCode": "sample string 17",
      "subscribe": "sample string 18",
      "userSettings": [
        {}
      ],
      "accountManagementGranular": {
        "canManageUsers": "sample string 1",
        "canManageAdmins": "sample string 2",
        "canManageGroups": "sample string 3",
        "canManageSharing": "sample string 4",
        "canManageUsersMetadata": {
          "rights": "sample string 1",
          "uiHint": "sample string 2",
          "uiType": "sample string 3",
          "uiOrder": "sample string 4",
          "is21CFRPart11": "sample string 5",
          "options": [
            "sample string 1"
          ]
        },
        "canManageAdminsMetadata": {},
        "canManageGroupsMetadata": {},
        "canManageSharingMetadata": {}
      },
      "sendActivationOnInvalidLogin": "sample string 19",
      "activationAccessCode": "sample string 20",
      "enableConnectForUser": "sample string 21",
      "forgottenPasswordInfo": {
        "forgottenPasswordQuestion1": "sample string 1",
        "forgottenPasswordAnswer1": "sample string 2",
        "forgottenPasswordQuestion2": "sample string 3",
        "forgottenPasswordAnswer2": "sample string 4",
        "forgottenPasswordQuestion3": "sample string 5",
        "forgottenPasswordAnswer3": "sample string 6",
        "forgottenPasswordQuestion4": "sample string 7",
        "forgottenPasswordAnswer4": "sample string 8"
      },
      "groupList": [
        {
          "groupId": "sample string 1",
          "groupName": "sample string 2",
          "permissionProfileId": "sample string 3",
          "groupType": "sample string 4",
          "users": [
            {
              "userName": "sample string 1",
              "userId": "sample string 2",
              "email": "sample string 3",
              "userType": "sample string 4",
              "userStatus": "sample string 5",
              "uri": "sample string 6",
              "loginStatus": "sample string 7",
              "sendActivationEmail": "sample string 8",
              "activationAccessCode": "sample string 9"
            }
          ]
        }
      ],
      "workAddress": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "city": "sample string 3",
        "stateOrProvince": "sample string 4",
        "postalCode": "sample string 5",
        "phone": "sample string 6",
        "fax": "sample string 7",
        "country": "sample string 8"
      },
      "homeAddress": {},
      "loginStatus": "sample string 22",
      "passwordExpiration": "sample string 23",
      "lastLogin": "sample string 24",
      "sendActivationEmail": "sample string 25",
      "customSettings": [
        {}
      ],
      "profileImageUri": "sample string 26",
      "userProfileLastModifiedDate": "sample string 27",
      "signatureImageUri": "sample string 28",
      "initialsImageUri": "sample string 29",
      "jobTitle": "sample string 30"
    }
  ],
  "modifiedDateTime": "sample string 3",
  "modifiedByUsername": "sample string 4",
  "userCount": "sample string 5",
  "settings": {
    "allowAccountManagement": "sample string 1",
    "useNewDocuSignExperienceInterface": "sample string 2",
    "canCreateWorkspaces": "sample string 3",
    "allowBulkSending": "sample string 4",
    "allowEnvelopeSending": "sample string 5",
    "allowESealRecipients": "sample string 6",
    "allowSignerAttachments": "sample string 7",
    "allowTaggingInSendAndCorrect": "sample string 8",
    "allowWetSigningOverride": "sample string 9",
    "allowedAddressBookAccess": "sample string 10",
    "allowedTemplateAccess": "sample string 11",
    "enableRecipientViewingNotifications": "sample string 12",
    "enableSequentialSigningInterface": "sample string 13",
    "receiveCompletedSelfSignedDocumentsAsEmailLinks": "sample string 14",
    "useNewSendingInterface": "sample string 15",
    "allowSupplementalDocuments": "sample string 16",
    "supplementalDocumentsMustView": "sample string 17",
    "supplementalDocumentsMustAccept": "sample string 18",
    "supplementalDocumentsMustRead": "sample string 19",
    "disableDocumentUpload": "sample string 20",
    "disableOtherActions": "sample string 21",
    "allowApiAccess": "sample string 22",
    "allowApiAccessToAccount": "sample string 23",
    "allowApiSendingOnBehalfOfOthers": "sample string 24",
    "allowApiSequentialSigning": "sample string 25",
    "enableApiRequestLogging": "sample string 26",
    "allowDocuSignDesktopClient": "sample string 27",
    "allowSendersToSetRecipientEmailLanguage": "sample string 28",
    "allowVaulting": "sample string 29",
    "allowedToBeEnvelopeTransferRecipient": "sample string 30",
    "enableTransactionPointIntegration": "sample string 31",
    "powerFormRole": "sample string 32",
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopes": "sample string 33",
    "vaultingMode": "sample string 34",
    "allowAccountManagementMetadata": {},
    "useNewDocuSignExperienceInterfaceMetadata": {},
    "canCreateWorkspacesMetadata": {},
    "allowBulkSendingMetadata": {},
    "allowEnvelopeSendingMetadata": {},
    "allowESealRecipientsMetadata": {},
    "allowSignerAttachmentsMetadata": {},
    "allowTaggingInSendAndCorrectMetadata": {},
    "allowWetSigningOverrideMetadata": {},
    "allowedAddressBookAccessMetadata": {},
    "allowedTemplateAccessMetadata": {},
    "enableRecipientViewingNotificationsMetadata": {},
    "enableSequentialSigningInterfaceMetadata": {},
    "receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata": {},
    "useNewSendingInterfaceMetadata": {},
    "allowSupplementalDocumentsMetadata": {},
    "supplementalDocumentsMustViewMetadata": {},
    "supplementalDocumentsMustAcceptMetadata": {},
    "supplementalDocumentsMustReadMetadata": {},
    "disableDocumentUploadMetadata": {},
    "disableOtherActionsMetadata": {},
    "allowApiAccessMetadata": {},
    "allowApiAccessToAccountMetadata": {},
    "allowApiSendingOnBehalfOfOthersMetadata": {},
    "allowApiSequentialSigningMetadata": {},
    "enableApiRequestLoggingMetadata": {},
    "allowDocuSignDesktopClientMetadata": {},
    "allowSendersToSetRecipientEmailLanguageMetadata": {},
    "allowVaultingMetadata": {},
    "allowedToBeEnvelopeTransferRecipientMetadata": {},
    "enableTransactionPointIntegrationMetadata": {},
    "powerFormRoleMetadata": {},
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata": {},
    "vaultingModeMetadata": {}
  }
}

Response

{
  "permissionProfileId": "sample string 1",
  "permissionProfileName": "sample string 2",
  "users": [
    {
      "userName": "sample string 1",
      "userId": "sample string 2",
      "userType": "sample string 3",
      "isAdmin": "sample string 4",
      "userStatus": "sample string 5",
      "uri": "sample string 6",
      "email": "sample string 7",
      "password": "sample string 8",
      "title": "sample string 9",
      "createdDateTime": "sample string 10",
      "firstName": "sample string 11",
      "middleName": "sample string 12",
      "lastName": "sample string 13",
      "suffixName": "sample string 14",
      "permissionProfileId": "sample string 15",
      "permissionProfileName": "sample string 16",
      "countryCode": "sample string 17",
      "subscribe": "sample string 18",
      "userSettings": [
        {}
      ],
      "accountManagementGranular": {
        "canManageUsers": "sample string 1",
        "canManageAdmins": "sample string 2",
        "canManageGroups": "sample string 3",
        "canManageSharing": "sample string 4",
        "canManageUsersMetadata": {
          "rights": "sample string 1",
          "uiHint": "sample string 2",
          "uiType": "sample string 3",
          "uiOrder": "sample string 4",
          "is21CFRPart11": "sample string 5",
          "options": [
            "sample string 1"
          ]
        },
        "canManageAdminsMetadata": {},
        "canManageGroupsMetadata": {},
        "canManageSharingMetadata": {}
      },
      "sendActivationOnInvalidLogin": "sample string 19",
      "activationAccessCode": "sample string 20",
      "enableConnectForUser": "sample string 21",
      "forgottenPasswordInfo": {
        "forgottenPasswordQuestion1": "sample string 1",
        "forgottenPasswordAnswer1": "sample string 2",
        "forgottenPasswordQuestion2": "sample string 3",
        "forgottenPasswordAnswer2": "sample string 4",
        "forgottenPasswordQuestion3": "sample string 5",
        "forgottenPasswordAnswer3": "sample string 6",
        "forgottenPasswordQuestion4": "sample string 7",
        "forgottenPasswordAnswer4": "sample string 8"
      },
      "groupList": [
        {
          "groupId": "sample string 1",
          "groupName": "sample string 2",
          "permissionProfileId": "sample string 3",
          "groupType": "sample string 4",
          "users": [
            {
              "userName": "sample string 1",
              "userId": "sample string 2",
              "email": "sample string 3",
              "userType": "sample string 4",
              "userStatus": "sample string 5",
              "uri": "sample string 6",
              "loginStatus": "sample string 7",
              "sendActivationEmail": "sample string 8",
              "activationAccessCode": "sample string 9",
              "errorDetails": {
                "errorCode": "sample string 1",
                "message": "sample string 2"
              }
            }
          ],
          "errorDetails": {
            "errorCode": "SUCCESS",
            "message": ""
          }
        }
      ],
      "workAddress": {
        "address1": "sample string 1",
        "address2": "sample string 2",
        "city": "sample string 3",
        "stateOrProvince": "sample string 4",
        "postalCode": "sample string 5",
        "phone": "sample string 6",
        "fax": "sample string 7",
        "country": "sample string 8"
      },
      "homeAddress": {},
      "loginStatus": "sample string 22",
      "passwordExpiration": "sample string 23",
      "lastLogin": "sample string 24",
      "sendActivationEmail": "sample string 25",
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      },
      "customSettings": [
        {}
      ],
      "profileImageUri": "sample string 26",
      "userProfileLastModifiedDate": "sample string 27",
      "signatureImageUri": "sample string 28",
      "initialsImageUri": "sample string 29",
      "jobTitle": "sample string 30"
    }
  ],
  "modifiedDateTime": "sample string 3",
  "modifiedByUsername": "sample string 4",
  "userCount": "sample string 5",
  "settings": {
    "allowAccountManagement": "sample string 1",
    "useNewDocuSignExperienceInterface": "sample string 2",
    "canCreateWorkspaces": "sample string 3",
    "allowBulkSending": "sample string 4",
    "allowEnvelopeSending": "sample string 5",
    "allowESealRecipients": "sample string 6",
    "allowSignerAttachments": "sample string 7",
    "allowTaggingInSendAndCorrect": "sample string 8",
    "allowWetSigningOverride": "sample string 9",
    "allowedAddressBookAccess": "sample string 10",
    "allowedTemplateAccess": "sample string 11",
    "enableRecipientViewingNotifications": "sample string 12",
    "enableSequentialSigningInterface": "sample string 13",
    "receiveCompletedSelfSignedDocumentsAsEmailLinks": "sample string 14",
    "useNewSendingInterface": "sample string 15",
    "allowSupplementalDocuments": "sample string 16",
    "supplementalDocumentsMustView": "sample string 17",
    "supplementalDocumentsMustAccept": "sample string 18",
    "supplementalDocumentsMustRead": "sample string 19",
    "disableDocumentUpload": "sample string 20",
    "disableOtherActions": "sample string 21",
    "allowApiAccess": "sample string 22",
    "allowApiAccessToAccount": "sample string 23",
    "allowApiSendingOnBehalfOfOthers": "sample string 24",
    "allowApiSequentialSigning": "sample string 25",
    "enableApiRequestLogging": "sample string 26",
    "allowDocuSignDesktopClient": "sample string 27",
    "allowSendersToSetRecipientEmailLanguage": "sample string 28",
    "allowVaulting": "sample string 29",
    "allowedToBeEnvelopeTransferRecipient": "sample string 30",
    "enableTransactionPointIntegration": "sample string 31",
    "powerFormRole": "sample string 32",
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopes": "sample string 33",
    "vaultingMode": "sample string 34",
    "allowAccountManagementMetadata": {},
    "useNewDocuSignExperienceInterfaceMetadata": {},
    "canCreateWorkspacesMetadata": {},
    "allowBulkSendingMetadata": {},
    "allowEnvelopeSendingMetadata": {},
    "allowESealRecipientsMetadata": {},
    "allowSignerAttachmentsMetadata": {},
    "allowTaggingInSendAndCorrectMetadata": {},
    "allowWetSigningOverrideMetadata": {},
    "allowedAddressBookAccessMetadata": {},
    "allowedTemplateAccessMetadata": {},
    "enableRecipientViewingNotificationsMetadata": {},
    "enableSequentialSigningInterfaceMetadata": {},
    "receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata": {},
    "useNewSendingInterfaceMetadata": {},
    "allowSupplementalDocumentsMetadata": {},
    "supplementalDocumentsMustViewMetadata": {},
    "supplementalDocumentsMustAcceptMetadata": {},
    "supplementalDocumentsMustReadMetadata": {},
    "disableDocumentUploadMetadata": {},
    "disableOtherActionsMetadata": {},
    "allowApiAccessMetadata": {},
    "allowApiAccessToAccountMetadata": {},
    "allowApiSendingOnBehalfOfOthersMetadata": {},
    "allowApiSequentialSigningMetadata": {},
    "enableApiRequestLoggingMetadata": {},
    "allowDocuSignDesktopClientMetadata": {},
    "allowSendersToSetRecipientEmailLanguageMetadata": {},
    "allowVaultingMetadata": {},
    "allowedToBeEnvelopeTransferRecipientMetadata": {},
    "enableTransactionPointIntegrationMetadata": {},
    "powerFormRoleMetadata": {},
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata": {},
    "vaultingModeMetadata": {}
  }
}

Generic XML Request/Response

Request

<permissionProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <modifiedByUsername>sample string 4</modifiedByUsername>
  <modifiedDateTime>sample string 3</modifiedDateTime>
  <permissionProfileId>sample string 1</permissionProfileId>
  <permissionProfileName>sample string 2</permissionProfileName>
  <settings>
    <allowAccountManagement>sample string 1</allowAccountManagement>
    <allowAccountManagementMetadata />
    <allowApiAccess>sample string 22</allowApiAccess>
    <allowApiAccessMetadata />
    <allowApiAccessToAccount>sample string 23</allowApiAccessToAccount>
    <allowApiAccessToAccountMetadata />
    <allowApiSendingOnBehalfOfOthers>sample string 24</allowApiSendingOnBehalfOfOthers>
    <allowApiSendingOnBehalfOfOthersMetadata />
    <allowApiSequentialSigning>sample string 25</allowApiSequentialSigning>
    <allowApiSequentialSigningMetadata />
    <allowBulkSending>sample string 4</allowBulkSending>
    <allowBulkSendingMetadata />
    <allowDocuSignDesktopClient>sample string 27</allowDocuSignDesktopClient>
    <allowDocuSignDesktopClientMetadata />
    <allowESealRecipients>sample string 6</allowESealRecipients>
    <allowESealRecipientsMetadata />
    <allowEnvelopeSending>sample string 5</allowEnvelopeSending>
    <allowEnvelopeSendingMetadata />
    <allowPowerFormsAdminToAccessAllPowerFormEnvelopes>sample string 33</allowPowerFormsAdminToAccessAllPowerFormEnvelopes>
    <allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata />
    <allowSendersToSetRecipientEmailLanguage>sample string 28</allowSendersToSetRecipientEmailLanguage>
    <allowSendersToSetRecipientEmailLanguageMetadata />
    <allowSignerAttachments>sample string 7</allowSignerAttachments>
    <allowSignerAttachmentsMetadata />
    <allowSupplementalDocuments>sample string 16</allowSupplementalDocuments>
    <allowSupplementalDocumentsMetadata />
    <allowTaggingInSendAndCorrect>sample string 8</allowTaggingInSendAndCorrect>
    <allowTaggingInSendAndCorrectMetadata />
    <allowVaulting>sample string 29</allowVaulting>
    <allowVaultingMetadata />
    <allowWetSigningOverride>sample string 9</allowWetSigningOverride>
    <allowWetSigningOverrideMetadata />
    <allowedAddressBookAccess>sample string 10</allowedAddressBookAccess>
    <allowedAddressBookAccessMetadata />
    <allowedTemplateAccess>sample string 11</allowedTemplateAccess>
    <allowedTemplateAccessMetadata />
    <allowedToBeEnvelopeTransferRecipient>sample string 30</allowedToBeEnvelopeTransferRecipient>
    <allowedToBeEnvelopeTransferRecipientMetadata />
    <canCreateWorkspaces>sample string 3</canCreateWorkspaces>
    <canCreateWorkspacesMetadata />
    <disableDocumentUpload>sample string 20</disableDocumentUpload>
    <disableDocumentUploadMetadata />
    <disableOtherActions>sample string 21</disableOtherActions>
    <disableOtherActionsMetadata />
    <enableApiRequestLogging>sample string 26</enableApiRequestLogging>
    <enableApiRequestLoggingMetadata />
    <enableRecipientViewingNotifications>sample string 12</enableRecipientViewingNotifications>
    <enableRecipientViewingNotificationsMetadata />
    <enableSequentialSigningInterface>sample string 13</enableSequentialSigningInterface>
    <enableSequentialSigningInterfaceMetadata />
    <enableTransactionPointIntegration>sample string 31</enableTransactionPointIntegration>
    <enableTransactionPointIntegrationMetadata />
    <powerFormRole>sample string 32</powerFormRole>
    <powerFormRoleMetadata />
    <receiveCompletedSelfSignedDocumentsAsEmailLinks>sample string 14</receiveCompletedSelfSignedDocumentsAsEmailLinks>
    <receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata />
    <supplementalDocumentsMustAccept>sample string 18</supplementalDocumentsMustAccept>
    <supplementalDocumentsMustAcceptMetadata />
    <supplementalDocumentsMustRead>sample string 19</supplementalDocumentsMustRead>
    <supplementalDocumentsMustReadMetadata />
    <supplementalDocumentsMustView>sample string 17</supplementalDocumentsMustView>
    <supplementalDocumentsMustViewMetadata />
    <useNewDocuSignExperienceInterface>sample string 2</useNewDocuSignExperienceInterface>
    <useNewDocuSignExperienceInterfaceMetadata />
    <useNewSendingInterface>sample string 15</useNewSendingInterface>
    <useNewSendingInterfaceMetadata />
    <vaultingMode>sample string 34</vaultingMode>
    <vaultingModeMetadata />
  </settings>
  <userCount>sample string 5</userCount>
  <users>
    <userInformation>
      <accountManagementGranular>
        <canManageAdmins>sample string 2</canManageAdmins>
        <canManageAdminsMetadata />
        <canManageGroups>sample string 3</canManageGroups>
        <canManageGroupsMetadata />
        <canManageSharing>sample string 4</canManageSharing>
        <canManageSharingMetadata />
        <canManageUsers>sample string 1</canManageUsers>
        <canManageUsersMetadata>
          <is21CFRPart11>sample string 5</is21CFRPart11>
          <options>
            <string>sample string 1</string>
          </options>
          <rights>sample string 1</rights>
          <uiHint>sample string 2</uiHint>
          <uiOrder>sample string 4</uiOrder>
          <uiType>sample string 3</uiType>
        </canManageUsersMetadata>
      </accountManagementGranular>
      <activationAccessCode>sample string 20</activationAccessCode>
      <countryCode>sample string 17</countryCode>
      <createdDateTime>sample string 10</createdDateTime>
      <customSettings>
        <nameValue />
      </customSettings>
      <email>sample string 7</email>
      <enableConnectForUser>sample string 21</enableConnectForUser>
      <firstName>sample string 11</firstName>
      <forgottenPasswordInfo>
        <forgottenPasswordAnswer1>sample string 2</forgottenPasswordAnswer1>
        <forgottenPasswordAnswer2>sample string 4</forgottenPasswordAnswer2>
        <forgottenPasswordAnswer3>sample string 6</forgottenPasswordAnswer3>
        <forgottenPasswordAnswer4>sample string 8</forgottenPasswordAnswer4>
        <forgottenPasswordQuestion1>sample string 1</forgottenPasswordQuestion1>
        <forgottenPasswordQuestion2>sample string 3</forgottenPasswordQuestion2>
        <forgottenPasswordQuestion3>sample string 5</forgottenPasswordQuestion3>
        <forgottenPasswordQuestion4>sample string 7</forgottenPasswordQuestion4>
      </forgottenPasswordInfo>
      <groupList>
        <group>
          <groupId>sample string 1</groupId>
          <groupName>sample string 2</groupName>
          <groupType>sample string 4</groupType>
          <permissionProfileId>sample string 3</permissionProfileId>
          <users>
            <userInfo>
              <activationAccessCode>sample string 9</activationAccessCode>
              <email>sample string 3</email>
              <loginStatus>sample string 7</loginStatus>
              <sendActivationEmail>sample string 8</sendActivationEmail>
              <uri>sample string 6</uri>
              <userId>sample string 2</userId>
              <userName>sample string 1</userName>
              <userStatus>sample string 5</userStatus>
              <userType>sample string 4</userType>
            </userInfo>
          </users>
        </group>
      </groupList>
      <homeAddress />
      <initialsImageUri>sample string 29</initialsImageUri>
      <isAdmin>sample string 4</isAdmin>
      <jobTitle>sample string 30</jobTitle>
      <lastLogin>sample string 24</lastLogin>
      <lastName>sample string 13</lastName>
      <loginStatus>sample string 22</loginStatus>
      <middleName>sample string 12</middleName>
      <password>sample string 8</password>
      <passwordExpiration>sample string 23</passwordExpiration>
      <permissionProfileId>sample string 15</permissionProfileId>
      <permissionProfileName>sample string 16</permissionProfileName>
      <profileImageUri>sample string 26</profileImageUri>
      <sendActivationEmail>sample string 25</sendActivationEmail>
      <sendActivationOnInvalidLogin>sample string 19</sendActivationOnInvalidLogin>
      <signatureImageUri>sample string 28</signatureImageUri>
      <subscribe>sample string 18</subscribe>
      <suffixName>sample string 14</suffixName>
      <title>sample string 9</title>
      <uri>sample string 6</uri>
      <userId>sample string 2</userId>
      <userName>sample string 1</userName>
      <userProfileLastModifiedDate>sample string 27</userProfileLastModifiedDate>
      <userSettings>
        <nameValue />
      </userSettings>
      <userStatus>sample string 5</userStatus>
      <userType>sample string 3</userType>
      <workAddress>
        <address1>sample string 1</address1>
        <address2>sample string 2</address2>
        <city>sample string 3</city>
        <country>sample string 8</country>
        <fax>sample string 7</fax>
        <phone>sample string 6</phone>
        <postalCode>sample string 5</postalCode>
        <stateOrProvince>sample string 4</stateOrProvince>
      </workAddress>
    </userInformation>
  </users>
</permissionProfile>

Response

<permissionProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <modifiedByUsername>sample string 4</modifiedByUsername>
  <modifiedDateTime>sample string 3</modifiedDateTime>
  <permissionProfileId>sample string 1</permissionProfileId>
  <permissionProfileName>sample string 2</permissionProfileName>
  <settings>
    <allowAccountManagement>sample string 1</allowAccountManagement>
    <allowAccountManagementMetadata />
    <allowApiAccess>sample string 22</allowApiAccess>
    <allowApiAccessMetadata />
    <allowApiAccessToAccount>sample string 23</allowApiAccessToAccount>
    <allowApiAccessToAccountMetadata />
    <allowApiSendingOnBehalfOfOthers>sample string 24</allowApiSendingOnBehalfOfOthers>
    <allowApiSendingOnBehalfOfOthersMetadata />
    <allowApiSequentialSigning>sample string 25</allowApiSequentialSigning>
    <allowApiSequentialSigningMetadata />
    <allowBulkSending>sample string 4</allowBulkSending>
    <allowBulkSendingMetadata />
    <allowDocuSignDesktopClient>sample string 27</allowDocuSignDesktopClient>
    <allowDocuSignDesktopClientMetadata />
    <allowESealRecipients>sample string 6</allowESealRecipients>
    <allowESealRecipientsMetadata />
    <allowEnvelopeSending>sample string 5</allowEnvelopeSending>
    <allowEnvelopeSendingMetadata />
    <allowPowerFormsAdminToAccessAllPowerFormEnvelopes>sample string 33</allowPowerFormsAdminToAccessAllPowerFormEnvelopes>
    <allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata />
    <allowSendersToSetRecipientEmailLanguage>sample string 28</allowSendersToSetRecipientEmailLanguage>
    <allowSendersToSetRecipientEmailLanguageMetadata />
    <allowSignerAttachments>sample string 7</allowSignerAttachments>
    <allowSignerAttachmentsMetadata />
    <allowSupplementalDocuments>sample string 16</allowSupplementalDocuments>
    <allowSupplementalDocumentsMetadata />
    <allowTaggingInSendAndCorrect>sample string 8</allowTaggingInSendAndCorrect>
    <allowTaggingInSendAndCorrectMetadata />
    <allowVaulting>sample string 29</allowVaulting>
    <allowVaultingMetadata />
    <allowWetSigningOverride>sample string 9</allowWetSigningOverride>
    <allowWetSigningOverrideMetadata />
    <allowedAddressBookAccess>sample string 10</allowedAddressBookAccess>
    <allowedAddressBookAccessMetadata />
    <allowedTemplateAccess>sample string 11</allowedTemplateAccess>
    <allowedTemplateAccessMetadata />
    <allowedToBeEnvelopeTransferRecipient>sample string 30</allowedToBeEnvelopeTransferRecipient>
    <allowedToBeEnvelopeTransferRecipientMetadata />
    <canCreateWorkspaces>sample string 3</canCreateWorkspaces>
    <canCreateWorkspacesMetadata />
    <disableDocumentUpload>sample string 20</disableDocumentUpload>
    <disableDocumentUploadMetadata />
    <disableOtherActions>sample string 21</disableOtherActions>
    <disableOtherActionsMetadata />
    <enableApiRequestLogging>sample string 26</enableApiRequestLogging>
    <enableApiRequestLoggingMetadata />
    <enableRecipientViewingNotifications>sample string 12</enableRecipientViewingNotifications>
    <enableRecipientViewingNotificationsMetadata />
    <enableSequentialSigningInterface>sample string 13</enableSequentialSigningInterface>
    <enableSequentialSigningInterfaceMetadata />
    <enableTransactionPointIntegration>sample string 31</enableTransactionPointIntegration>
    <enableTransactionPointIntegrationMetadata />
    <powerFormRole>sample string 32</powerFormRole>
    <powerFormRoleMetadata />
    <receiveCompletedSelfSignedDocumentsAsEmailLinks>sample string 14</receiveCompletedSelfSignedDocumentsAsEmailLinks>
    <receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata />
    <supplementalDocumentsMustAccept>sample string 18</supplementalDocumentsMustAccept>
    <supplementalDocumentsMustAcceptMetadata />
    <supplementalDocumentsMustRead>sample string 19</supplementalDocumentsMustRead>
    <supplementalDocumentsMustReadMetadata />
    <supplementalDocumentsMustView>sample string 17</supplementalDocumentsMustView>
    <supplementalDocumentsMustViewMetadata />
    <useNewDocuSignExperienceInterface>sample string 2</useNewDocuSignExperienceInterface>
    <useNewDocuSignExperienceInterfaceMetadata />
    <useNewSendingInterface>sample string 15</useNewSendingInterface>
    <useNewSendingInterfaceMetadata />
    <vaultingMode>sample string 34</vaultingMode>
    <vaultingModeMetadata />
  </settings>
  <userCount>sample string 5</userCount>
  <users>
    <userInformation>
      <accountManagementGranular>
        <canManageAdmins>sample string 2</canManageAdmins>
        <canManageAdminsMetadata />
        <canManageGroups>sample string 3</canManageGroups>
        <canManageGroupsMetadata />
        <canManageSharing>sample string 4</canManageSharing>
        <canManageSharingMetadata />
        <canManageUsers>sample string 1</canManageUsers>
        <canManageUsersMetadata>
          <is21CFRPart11>sample string 5</is21CFRPart11>
          <options>
            <string>sample string 1</string>
          </options>
          <rights>sample string 1</rights>
          <uiHint>sample string 2</uiHint>
          <uiOrder>sample string 4</uiOrder>
          <uiType>sample string 3</uiType>
        </canManageUsersMetadata>
      </accountManagementGranular>
      <activationAccessCode>sample string 20</activationAccessCode>
      <countryCode>sample string 17</countryCode>
      <createdDateTime>sample string 10</createdDateTime>
      <customSettings>
        <nameValue />
      </customSettings>
      <email>sample string 7</email>
      <enableConnectForUser>sample string 21</enableConnectForUser>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <firstName>sample string 11</firstName>
      <forgottenPasswordInfo>
        <forgottenPasswordAnswer1>sample string 2</forgottenPasswordAnswer1>
        <forgottenPasswordAnswer2>sample string 4</forgottenPasswordAnswer2>
        <forgottenPasswordAnswer3>sample string 6</forgottenPasswordAnswer3>
        <forgottenPasswordAnswer4>sample string 8</forgottenPasswordAnswer4>
        <forgottenPasswordQuestion1>sample string 1</forgottenPasswordQuestion1>
        <forgottenPasswordQuestion2>sample string 3</forgottenPasswordQuestion2>
        <forgottenPasswordQuestion3>sample string 5</forgottenPasswordQuestion3>
        <forgottenPasswordQuestion4>sample string 7</forgottenPasswordQuestion4>
      </forgottenPasswordInfo>
      <groupList>
        <group>
          <errorDetails>
            <errorCode>SUCCESS</errorCode>
            <message></message>
          </errorDetails>
          <groupId>sample string 1</groupId>
          <groupName>sample string 2</groupName>
          <groupType>sample string 4</groupType>
          <permissionProfileId>sample string 3</permissionProfileId>
          <users>
            <userInfo>
              <activationAccessCode>sample string 9</activationAccessCode>
              <email>sample string 3</email>
              <errorDetails>
                <errorCode>sample string 1</errorCode>
                <message>sample string 2</message>
              </errorDetails>
              <loginStatus>sample string 7</loginStatus>
              <sendActivationEmail>sample string 8</sendActivationEmail>
              <uri>sample string 6</uri>
              <userId>sample string 2</userId>
              <userName>sample string 1</userName>
              <userStatus>sample string 5</userStatus>
              <userType>sample string 4</userType>
            </userInfo>
          </users>
        </group>
      </groupList>
      <homeAddress />
      <initialsImageUri>sample string 29</initialsImageUri>
      <isAdmin>sample string 4</isAdmin>
      <jobTitle>sample string 30</jobTitle>
      <lastLogin>sample string 24</lastLogin>
      <lastName>sample string 13</lastName>
      <loginStatus>sample string 22</loginStatus>
      <middleName>sample string 12</middleName>
      <password>sample string 8</password>
      <passwordExpiration>sample string 23</passwordExpiration>
      <permissionProfileId>sample string 15</permissionProfileId>
      <permissionProfileName>sample string 16</permissionProfileName>
      <profileImageUri>sample string 26</profileImageUri>
      <sendActivationEmail>sample string 25</sendActivationEmail>
      <sendActivationOnInvalidLogin>sample string 19</sendActivationOnInvalidLogin>
      <signatureImageUri>sample string 28</signatureImageUri>
      <subscribe>sample string 18</subscribe>
      <suffixName>sample string 14</suffixName>
      <title>sample string 9</title>
      <uri>sample string 6</uri>
      <userId>sample string 2</userId>
      <userName>sample string 1</userName>
      <userProfileLastModifiedDate>sample string 27</userProfileLastModifiedDate>
      <userSettings>
        <nameValue />
      </userSettings>
      <userStatus>sample string 5</userStatus>
      <userType>sample string 3</userType>
      <workAddress>
        <address1>sample string 1</address1>
        <address2>sample string 2</address2>
        <city>sample string 3</city>
        <country>sample string 8</country>
        <fax>sample string 7</fax>
        <phone>sample string 6</phone>
        <postalCode>sample string 5</postalCode>
        <stateOrProvince>sample string 4</stateOrProvince>
      </workAddress>
    </userInformation>
  </users>
</permissionProfile>

}} />