Request

HTTP request

PUT /v2/accounts/{accountId}/permission_profiles/{permissionProfileId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

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

permissionProfileIdstring

Optional Query Parameters
includestring

A comma-separated list of additional template attributes to include in the response. Valid values are: recipients, folders, documents, custom_fields, and notifications.

Responses

CodeDescriptionReference
200

Successful response.

AccountPermissionProfiles
400

Error encountered.

errorDetails

SDK Method

Accounts::updatePermissionProfile

Definitions

accountRoleSettings

allowAccountManagementstring

allowAccountManagementMetadatasettingsMetadata

allowApiAccessstring

allowApiAccessMetadatasettingsMetadata

allowApiAccessToAccountstring

allowApiAccessToAccountMetadatasettingsMetadata

allowApiSendingOnBehalfOfOthersstring

allowApiSendingOnBehalfOfOthersMetadatasettingsMetadata

allowApiSequentialSigningstring

allowApiSequentialSigningMetadatasettingsMetadata

allowBulkSendingstring

allowBulkSendingMetadatasettingsMetadata

allowDocuSignDesktopClientstring

allowDocuSignDesktopClientMetadatasettingsMetadata

allowedAddressBookAccessstring

allowedAddressBookAccessMetadatasettingsMetadata

allowedTemplateAccessstring

allowedTemplateAccessMetadatasettingsMetadata

allowedToBeEnvelopeTransferRecipientstring

allowedToBeEnvelopeTransferRecipientMetadatasettingsMetadata

allowEnvelopeSendingstring

allowEnvelopeSendingMetadatasettingsMetadata

allowESealRecipientsstring

allowESealRecipientsMetadatasettingsMetadata

allowPowerFormsAdminToAccessAllPowerFormEnvelopesstring

allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadatasettingsMetadata

allowSendersToSetRecipientEmailLanguagestring

allowSendersToSetRecipientEmailLanguageMetadatasettingsMetadata

allowSignerAttachmentsstring

allowSignerAttachmentsMetadatasettingsMetadata

allowSupplementalDocumentsstring

allowSupplementalDocumentsMetadatasettingsMetadata

allowTaggingInSendAndCorrectstring

allowTaggingInSendAndCorrectMetadatasettingsMetadata

allowVaultingstring

allowVaultingMetadatasettingsMetadata

allowWetSigningOverridestring

allowWetSigningOverrideMetadatasettingsMetadata

canCreateWorkspacesstring

canCreateWorkspacesMetadatasettingsMetadata

disableDocumentUploadstring

disableDocumentUploadMetadatasettingsMetadata

disableOtherActionsstring

disableOtherActionsMetadatasettingsMetadata

enableApiRequestLoggingstring

enableApiRequestLoggingMetadatasettingsMetadata

enableRecipientViewingNotificationsstring

enableRecipientViewingNotificationsMetadatasettingsMetadata

enableSequentialSigningInterfacestring

enableSequentialSigningInterfaceMetadatasettingsMetadata

enableTransactionPointIntegrationstring

enableTransactionPointIntegrationMetadatasettingsMetadata

powerFormRolestring

powerFormRoleMetadatasettingsMetadata

receiveCompletedSelfSignedDocumentsAsEmailLinksstring

receiveCompletedSelfSignedDocumentsAsEmailLinksMetadatasettingsMetadata

supplementalDocumentsMustAcceptstring

supplementalDocumentsMustAcceptMetadatasettingsMetadata

supplementalDocumentsMustReadstring

supplementalDocumentsMustReadMetadatasettingsMetadata

supplementalDocumentsMustViewstring

supplementalDocumentsMustViewMetadatasettingsMetadata

useNewDocuSignExperienceInterfacestring

useNewDocuSignExperienceInterfaceMetadatasettingsMetadata

useNewSendingInterfacestring

useNewSendingInterfaceMetadatasettingsMetadata

vaultingModestring

vaultingModeMetadatasettingsMetadata

addressInformation_v2

address1string

First Line of the address. Maximum length: 100 characters.

address2string

Second Line of the address. Maximum length: 100 characters.

citystring

countrystring

Specifies the country associated with the address.

faxstring

phonestring

postalCodestring

stateOrProvincestring

The state or province associated with the address.

errorDetails

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

errorCodestring

An error code associated with the error.

messagestring

A short error message.

forgottenPasswordInformation

A complex element that has up to four Question/Answer pairs for forgotten password information.

forgottenPasswordAnswer1string

The answer to the first forgotten password challenge question.

forgottenPasswordAnswer2string

The answer to the second forgotten password challenge question.

forgottenPasswordAnswer3string

The answer to the third forgotten password challenge question.

forgottenPasswordAnswer4string

The answer to the fourth forgotten password challenge question.

forgottenPasswordQuestion1string

The first challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion2string

The second challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion3string

The third challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion4string

The fourth challenge question presented to a user who has forgotten their password.

group

Information about groups.

errorDetailserrorDetails

groupIdstring

The DocuSign group ID for the group.

groupNamestring

The name of the group.

groupTypestring

The group type.

permissionProfileIdstring

The ID of the permission profile associated with the group.

users[userInfo]

List of users in the group.

nameValue

errorDetailserrorDetails

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

settingsMetadata

is21CFRPart11string

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

options[array]

rightsstring

uiHintstring

uiOrderstring

uiTypestring

userAccountManagementGranularInformation

Describes which account management capabilities a user has.

canManageAccountSecuritySettingsstring

canManageAccountSecuritySettingsMetadatasettingsMetadata

canManageAccountSettingsstring

canManageAccountSettingsMetadatasettingsMetadata

canManageAdminsstring

True if the user can manage admins.

canManageAdminsMetadatasettingsMetadata

canManageGroupsstring

True if the user can manage groups.

canManageGroupsMetadatasettingsMetadata

canManageReportingstring

canManageReportingMetadatasettingsMetadata

canManageSharingstring

canManageSharingMetadatasettingsMetadata

canManageSigningGroupsstring

canManageSigningGroupsMetadatasettingsMetadata

canManageUsersstring

True if the user can manage users.

canManageUsersMetadatasettingsMetadata

userInfo

activationAccessCodestring

emailstring

errorDetailserrorDetails

loginStatusstring

sendActivationEmailstring

uristring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

userNamestring

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

Users

User management

accountManagementGranularuserAccountManagementGranularInformation

Describes which account management capabilities a user has.

activationAccessCodestring

The activation code the new user must enter when activating their account.

countryCodestring

createdDateTimestring

Indicates the date and time the item was created.

customSettings[nameValue]

The name/value pair information for the user custom setting.

emailstring

The user's email address.

enableConnectForUserstring

Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false.

errorDetailserrorDetails

firstNamestring

The user's first name. Maximum Length: 50 characters.

forgottenPasswordInfoforgottenPasswordInformation

A complex element that has 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.

homeAddressaddressInformation_v2

The user's physical home address.

initialsImageUristring

Contains the URI for an endpoint that you can use to retrieve the initials image.

isAdminstring

Determines if the feature set is actively set as part of the plan.

lastLoginstring

The date-time when the user last logged on to the system.

lastNamestring

The user's last name. Maximum Length: 50 characters.

loginStatusstring

Shows the current status of the user's password. Possible values are:

  • password_reset
  • password_active
  • password_expired
  • password_locked
  • password_reset_failed

middleNamestring

The user's middle name. Limit: 50 characters.

passwordstring

passwordExpirationstring

If password expiration is enabled, the date-time when the user's password expires.

permissionProfileIdstring

permissionProfileNamestring

profileImageUristring

sendActivationEmailstring

sendActivationOnInvalidLoginstring

When set to true, specifies that an additional activation email is sent to the user if they fail a log on before activating their account.

signatureImageUristring

Contains the URI for an endpoint that you can use to retrieve the signature image.

subscribestring

suffixNamestring

The suffix for the user's name, such as Jr, IV, PhD, etc.

Limit: 50 characters.

titlestring

Salutation for the user, such as Ms, Dr, Capt., etc.

Limit: 10 characters.

uristring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

userNamestring

The user's full name.

userProfileLastModifiedDatestring

The date-time when the user's profile was last modified.

userSettings[nameValue]

The collection of settings that describes the actions a user can perform. See User Settings for a list of available settings.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

workAddressaddressInformation_v2

The user's physical work address.

AccountPermissionProfiles

modifiedByUsernamestring

modifiedDateTimestring

permissionProfileIdstring

permissionProfileNamestring

settingsaccountRoleSettings

userCountstring

users[Users]

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> 
}} />