Skip to navigation
Docusign eSignature REST APIAccounts

AccountPermissionProfiles Resource

View as Markdown

An account permission profile is assigned to a group of users, enabling you to set permissions for all of the users in the group at the same time. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users.

Docusign offers the following account permission profiles:

  • Docusign Viewer
  • Docusign Sender
  • Account Administrator

You can also create your own custom account permission profiles.

Methods supported

MethodDescription
createPOST /restapi/v2.1/accounts/{accountId}/permission_profiles
Creates a new permission profile for an account.
deleteDEL /restapi/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}
Deletes a permission profile from an account.
getGET /restapi/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}
Returns a permission profile for an account.
listGET /restapi/v2.1/accounts/{accountId}/permission_profiles
Gets a list of permission profiles.
updatePUT /restapi/v2.1/accounts/{accountId}/permission_profiles/{permissionProfileId}
Updates a permission profile.

AccountPermissionProfiles properties

PropertyTypeDescription
modifiedByUsernamestringThe username of the user who last modified the permission profile.
modifiedDateTimestringThe date and time when the permission profile was last modified.
permissionProfileIdstringThe ID of the permission profile.

Use AccountPermissionProfiles: list to get a list of permission profiles and their IDs.

You can also download a CSV file of all permission profiles and their IDs from the Settings > Permission Profiles page of your eSignature account page.
permissionProfileNamestringThe name of the account permission profile.

Example: Account Administrator
settingsaccountRoleSettingsThis object specifies the permissions that are associated with the account permission profile.
userCountstringThe total number of users in the group associated with the account permission profile.
usersarrayA list of user objects containing information about the users who are associated with the account permission profile.