--- title: "Reserved: Sets the shared access information for users." method: PUT path: "/v2.1/accounts/{accountId}/shared_access" tags: ["Accounts"] --- # Reserved: Sets the shared access information for users. `PUT /v2.1/accounts/{accountId}/shared_access` This sets the shared access status for one or more users or templates. When setting user shared access, only users with account administration privileges can set shared access status for envelopes. When setting template shared access, only users who own a template and have sharing permission or with account administration privileges can set shared access for templates. Changes to the shared items status are not additive. The change always replaces the current status. To change template shared access, add the query parameter `item_type` = `templates` to the request. When this is set, the user and envelopes properties are not required. **Note:** This functionality is a newer version of the [Update Group Share](/docs/esign-rest-api/reference/templates/templates/updategroupshare/) functionality. ### Related topics - [How to share access to a Docusign envelope inbox](/docs/esign-rest-api/how-to/shared-access/) ## Path parameters - `accountId` string, required ## Query parameters - `item_type` string - `preserve_existing_shared_access` string - `user_ids` string ## Request body - AccountSharedAccess — Contains shared access information. - `accountId` string — The account ID associated with the envelope. - `endPosition` string — The last index position in the result set. - `errorDetails` 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. - `nextUri` string — The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - `previousUri` string — The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - `resultSetSize` string — The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`. - `sharedAccess` MemberSharedItems[] — A list of shared access information of envelope and templates for the users specified in the request. - `envelopes` SharedItem[] — List of information about shared envelopes. - `errorDetails` 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. - `shared` string — How the item is shared. One of: - `not_shared` - `shared_to` - `shared_from` - `shared_to_and_from` - `user` UserInfo - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` 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. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). - `uri` string — A URI containing the user ID. - `userId` string — The ID of the user to access. - `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`. - `errorDetails` 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. - `folders` FolderSharedItem[] — List of information about shared folders. - `errorDetails` 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. - `folderId` string — The ID of the folder. - `name` string — The name of the folder. - `owner` UserInfo - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` 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. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). - `uri` string — A URI containing the user ID. - `userId` string — The ID of the user to access. - `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`. - `parentFolderId` string — The ID of the parent folder. - `parentFolderUri` string — The URI for the parent folder. - `shared` string — Indicates how the folder is shared. Valid values are: - `not_shared` - `shared_to` - `sharedGroups` MemberGroupSharedItem[] — A list of groups that share the folder. - `errorDetails` 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. - `group` Group — This object contains information about a group. - `accessType` string - `dsGroupId` string — Reserved for Docusign. - `errorDetails` 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. - `groupId` string — The Docusign group ID for the group. This is a read-only property. - `groupName` string — The name of the group. - `groupType` string — The group type. - `isManagedByScim` boolean - `lastModifiedOn` string - `permissionProfileId` string — The ID of the permission profile associated with the group. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. - `userGroupType` string - `users` UserInfo[] — A list of the users in the group. This property is not used by [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/). To get a list of users see [GroupUsers: list](/docs/esign-rest-api/reference/usergroups/groupusers/list/) - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). - `uri` string — A URI containing the user ID. - `userId` string — The ID of the user to access. - `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`. - `usersCount` string — The total number of users in the group. - `shared` string — How the item is shared. One of: - `not_shared`: The item is not shared. - `shared_to`: The item is shared. - `sharedUsers` UserSharedItem[] — A list of users that share the folder. - `errorDetails` 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. - `shared` string — How the item is shared. One of: - `not_shared` - `shared_to` - `shared_from` - `shared_to_and_from` - `user` UserInfo - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` 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. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). - `uri` string — A URI containing the user ID. - `userId` string — The ID of the user to access. - `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`. - `uri` string — A URI containing the user ID. - `user` UserInfo - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` 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. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). - `uri` string — A URI containing the user ID. - `userId` string — The ID of the user to access. - `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`. - `templates` TemplateSharedItem[] — List of information about shared templates. - `errorDetails` 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. - `owner` UserInfo - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` 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. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). - `uri` string — A URI containing the user ID. - `userId` string — The ID of the user to access. - `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`. - `password` string — The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests. - `shared` string — How the template is shared. One of: - `not_shared` - `shared_to` - `sharedGroups` MemberGroupSharedItem[] — List of groups that share the template. - `errorDetails` 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. - `group` Group — This object contains information about a group. - `accessType` string - `dsGroupId` string — Reserved for Docusign. - `errorDetails` 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. - `groupId` string — The Docusign group ID for the group. This is a read-only property. - `groupName` string — The name of the group. - `groupType` string — The group type. - `isManagedByScim` boolean - `lastModifiedOn` string - `permissionProfileId` string — The ID of the permission profile associated with the group. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. - `userGroupType` string - `users` UserInfo[] — A list of the users in the group. This property is not used by [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/). To get a list of users see [GroupUsers: list](/docs/esign-rest-api/reference/usergroups/groupusers/list/) - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - … - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). - `uri` string — A URI containing the user ID. - `userId` string — The ID of the user to access. - `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`. - `usersCount` string — The total number of users in the group. - `shared` string — How the item is shared. One of: - `not_shared`: The item is not shared. - `shared_to`: The item is shared. - `sharedUsers` UserSharedItem[] — List of users that share the template. - `errorDetails` 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. - `shared` string — How the item is shared. One of: - `not_shared` - `shared_to` - `shared_from` - `shared_to_and_from` - `user` UserInfo - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` 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. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). - `uri` string — A URI containing the user ID. - `userId` string — The ID of the user to access. - `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`. - `templateId` string — The unique identifier of the template. If this is not provided, Docusign will generate a value. - `templateName` string — The name of the shared template. - `user` UserInfo - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` 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. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/). - `uri` string — A URI containing the user ID. - `userId` string — The ID of the user to access. - `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`. - `startPosition` string — The starting index position of the current result set. - `totalSetSize` string — The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. ## Response `200` Successful response. ## Other responses - `400` — Error encountered. --- [API](https://skmtc.net/docusign/apis/docusign-esignature-rest-api.md) · [All operations](https://skmtc.net/docusign/apis/docusign-esignature-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/docusign/docusign-esignature-rest-api/versions/77f1998c313d/schema)